> ## Documentation Index
> Fetch the complete documentation index at: https://connect.watson-orchestrate.ibm.com/llms.txt
> Use this file to discover all available pages before exploring further.

# MCP Server Integration (BYOL)

## Overview

The Model Context Protocol (MCP) server integration allows builders to add partner Remote MCP servers directly from the watsonx Orchestrate catalog to their agents. This guide covers the submission process for **BYOL (Bring Your Own License)** listings where you maintain your own licensing agreements with end customers.

<Note>
  Looking for paid listing instructions? See [MCP Server Integration (Paid Listing)](./mcp-server).
</Note>

## Quick Start: Accessing the BYOL Form

To begin submitting your BYOL MCP server:

1. Navigate to the **IBM Concierge** platform
2. Go to the **My AI products** page
3. Click the **Create** button
4. Select **Create BYOL listing** in the License type section
5. Select **MCP Server** as the Product type
6. Follow the detailed steps below to complete your submission

<Note>
  The BYOL path bypasses several approval steps required for paid listings, allowing you to publish immediately after configuration.
</Note>

## Prerequisites

Before submitting your MCP server, ensure you have:

* **Remote MCP server**: A functioning Remote MCP server endpoint
* **APP\_ID**: Unique identifier provided by IBM Ecosystem team (obtained via email)
* **Test credentials**: Valid credentials for IBM to create test connections
* **Documentation**: Setup documentation and at least one use case for testing
* **Authentication**: Supported authentication schema configured (OAuth2, API Key, Bearer Token, Basic Auth, or Key-Value)
* **Icon**: Square icon for your application (max size 200×200px)
* **Licensing system**: Your own license validation and management system

## Supported Authentication Schemas

The MCP server supports all authentication schemas available in the watsonx Orchestrate platform:

* **OAuth2** (without Dynamic Client Registration)
* **API Key**
* **Bearer Token**
* **Basic Auth**
* **Key-Value**

For detailed authentication implementation guidance, see the [Remote MCP Toolkits documentation <Icon icon="arrow-up-right-from-square" iconType="solid" />](https://developer.watson-orchestrate.ibm.com/tools/toolkits/remote_mcp_toolkits).

## Obtaining Your APP\_ID

Before you can submit your MCP server through Concierge, you need to obtain an APP\_ID from the IBM Ecosystem team.

### Request Process

Contact the IBM Ecosystem team to request your APP\_ID:

* **Email**: **[IBMAgentConnect@ibm.com](mailto:IBMAgentConnect@ibm.com)**
* **Subject**: "MCP APP\_ID Request - \[Your Company Name]"
* **Include**:
  * Company name
  * MCP server name
  * Brief description
  * Submission type: **BYOL**

The IBM Ecosystem team will respond via email with your unique APP\_ID. This APP\_ID is required when configuring your MCP server in the Concierge platform.

<Note>
  **Important**: Save the APP\_ID from the email response. You will need it when filling out the product details in Concierge.
</Note>

## Submission Process

### Step 1: Create Your MCP Server Product

<Steps>
  <Step title="Access IBM Concierge">
    Navigate to the IBM Concierge platform and go to the **My AI products** page.
  </Step>

  <Step title="Click Create button">
    Click the **Create** button to start creating a new AI product.
  </Step>

  <Step title="Select license type">
    In the **License type** section, select **Create BYOL listing**.

    Click **Next** to continue.
  </Step>

  <Step title="Select product type">
    In the **Product type** section:

    1. Select **MCP Server**
    2. Click **Next**
  </Step>

  <Step title="Provide product details">
    In the **Product details** section:

    * **Display name**: Enter a user-friendly name for your MCP server

    <Warning>
      **Display Name** - Allowed characters:

      * Lowercase letters: `a-z`
      * Numbers: `0-9`
      * Space: ` `
      * Forward slash: `/`
      * Parentheses: `(` `)`
      * Period: `.`
      * Hyphen: `-`
    </Warning>

    <Note>
      For BYOL listings, you do not provide the programmatic name during creation. It will be automatically generated from your display name in the configuration step.
    </Note>

    Click **Next** to continue.
  </Step>

  <Step title="Review and create">
    Review your product details and click **Create** to create your MCP server product.
  </Step>
</Steps>

### Step 2: Configure Your MCP Server

After creating your product, you'll be able to edit and configure all the details.

<Steps>
  <Step title="Basic information">
    Configure the basic product information:

    * **Name**: The programmatic MCP server name (derived from Display Name, read-only)
    * **Display Name**: User-friendly name for the catalog tile (used to auto-generate the programmatic name)
    * **Description**: Detailed description of your MCP server capabilities and features
    * **Version**: MCP version (e.g., "1.0.0")
    * **Change log**: Document changes in this version
  </Step>

  <Step title="Categorization and language">
    Configure categorization and language support:

    * **Domain tags**: Select 1-3 catalog categories:
      * Customer Care
      * Finance
      * Healthcare
      * HR
      * Legal
      * News
      * Procurement
      * Productivity
      * Research
      * Sales
      * Security
      * Talent Management
    * **Language support**: Select all supported languages (e.g., English)
  </Step>

  <Step title="Application details">
    Configure application-specific settings:

    * **Application ID**: Enter your APP\_ID (received via email from IBM Ecosystem team)
    * **Application Name**: Your company name (recommended for searchability, though you can use any name)
    * **Application icon**: Upload your square icon (max size 200×200px)

    <Note>
      **Application Name**: It's best to use your actual company name to make your MCP server easily searchable in the catalog.
    </Note>
  </Step>

  <Step title="MCP server configuration">
    Provide your MCP server endpoint configuration:

    * **Server end-point URL**: Your Remote MCP server endpoint URL
    * **Transport**: Select transport type:
      * Streamable HTTP
      * SSE
  </Step>

  <Step title="Configure authentication">
    Click the **Connect** button to provide authentication details for your MCP server:

    * Select your authentication schema (OAuth2, API Key, Bearer Token, Basic Auth, or Key-Value)
    * Provide the required credentials and configuration for the selected schema
    * Test the connection to ensure it works correctly
  </Step>

  <Step title="Add related links">
    Under **Related links**, click **Add custom links** to provide:

    * **Support** (required): Link to your support resources
    * **Terms and Conditions** (required): Link to your end-customer EULA
    * **Documentation** (optional): Link to setup and usage documentation
    * **Demo** (optional): Link to demo video or materials
    * **Training** (optional): Link to training materials
  </Step>

  <Step title="Save your configuration">
    Click **Save** to save your MCP server configuration.
  </Step>
</Steps>

### Step 3: Publish Your MCP Server

For BYOL listings, you can publish without IBM approval:

<Steps>
  <Step title="Review your configuration">
    Review your MCP server configuration to ensure all information is correct and complete.
  </Step>

  <Step title="Click Publish">
    Click **Publish** to initiate the publishing process.

    <Warning>
      **Publishing Timeline**: After clicking Publish, your MCP server will go through the watsonx Orchestrate release pipeline. It can take **up to 3 weeks** for your MCP server to appear in the catalog.
    </Warning>
  </Step>
</Steps>

## BYOL-Specific Considerations

### Licensing Management

* **Custom licensing**: You maintain your own licensing agreements with end customers
* **License validation**: Your MCP server must handle license validation independently
* **APP\_ID usage**: The APP\_ID provided by IBM is used for catalog identification, not license management
* **Customer onboarding**: You're responsible for customer licensing and onboarding workflows

### Support Model

* **Direct support**: You provide direct support to your customers
* **License issues**: Handle all license-related inquiries and issues
* **Technical support**: Provide technical support for your MCP server functionality

### Catalog Visibility

* **Immediate publishing**: BYOL listings can be published without IBM approval
* **Release pipeline**: Still subject to the watsonx Orchestrate release schedule (up to 3 weeks)
* **Catalog presence**: Your MCP server appears in the catalog with BYOL designation

## What Happens After Publishing

Once your MCP server is published and appears in the catalog:

1. **Catalog listing**: Your MCP server appears in the watsonx Orchestrate catalog as a BYOL listing

2. **Builder access**: Builders can discover and add your Remote MCP server to their agents directly from the catalog

3. **Connection management**: Builders configure connections using the authentication schema you specified

4. **License validation**: Your MCP server validates licenses according to your licensing system

5. **Usage tracking**: Monitor adoption and usage through IBM Ecosystem team reports

6. **Direct billing**: You handle all billing and licensing directly with your customers

## Updating Your MCP Server

To update your MCP server listing:

1. Access your MCP server product in IBM Concierge
2. Navigate to the **My AI products** page
3. Select your MCP server product
4. Update the relevant fields:
   * Increment the version number
   * Update description, documentation links, or other details
   * Add notes to the change log explaining the updates
5. Click **Save**
6. Click **Publish** to publish the update

<Warning>
  Updates still go through the watsonx Orchestrate release pipeline. Allow up to 3 weeks for the update to appear in the catalog after publishing.
</Warning>

<Note>
  If you've lost your APP\_ID, contact **[IBMAgentConnect@ibm.com](mailto:IBMAgentConnect@ibm.com)** with your MCP server name to retrieve it.
</Note>

## Troubleshooting

### Common Issues

**APP\_ID not received:**

* Contact **[IBMAgentConnect@ibm.com](mailto:IBMAgentConnect@ibm.com)** with subject "APP\_ID Request - \[Company Name]"
* Specify "BYOL" in your request
* Allow 2-3 business days for APP\_ID assignment

**Naming validation errors:**

* Verify display name uses only allowed characters: `a-z`, `0-9`, space, `/`, `(`, `)`, `.`, `-`

**Concierge form validation errors:**

* Ensure all required fields are populated
* Check that APP\_ID matches the one provided by IBM via email
* Validate URLs are properly formatted and accessible
* Verify icon file meets size and format requirements

**Authentication connection failures:**

* Confirm test credentials are valid and not expired
* Verify authentication schema matches your MCP server configuration
* Check that credentials have appropriate permissions
* Test connection manually before saving

**MCP server endpoint issues:**

* Ensure MCP server endpoint is publicly accessible
* Verify transport type (Streamable HTTP or SSE) is correctly specified
* Check firewall and security settings allow IBM access
* Test endpoint connectivity from external networks

**Publishing blocked:**

* Ensure all required fields are saved
* Check for any validation errors in the form
* Verify programmatic name has been provided

**MCP server not appearing in catalog:**

* Remember that it can take up to 3 weeks after publishing for your MCP server to appear
* Check the watsonx Orchestrate release schedule
* Contact **[IBMAgentConnect@ibm.com](mailto:IBMAgentConnect@ibm.com)** if it's been longer than 3 weeks

**License validation issues:**

* Ensure your MCP server properly validates licenses
* Test license validation with various scenarios
* Provide clear error messages to users when licenses are invalid
* Document license requirements in your support materials

## Need Help?

For questions or support:

* **Email**: **[IBMAgentConnect@ibm.com](mailto:IBMAgentConnect@ibm.com)**
* **Subject format**: "MCP BYOL Support - \[Your Company Name] - \[Issue Type]"
* **Include**: MCP server name, APP\_ID, error messages, and relevant details

**Useful resources:**

* [Remote MCP Toolkits Documentation <Icon icon="arrow-up-right-from-square" iconType="solid" />](https://developer.watson-orchestrate.ibm.com/tools/toolkits/remote_mcp_toolkits)
* [MCP Server Integration (Paid Listing)](./mcp-server)
* [AI Product Onboarding](./onboard)
* [IBM Support](https://ibm.com/mysupport)