Skip to main content
Interim Solution: This documentation covers the MCP listing capability, planned for delivery by end of March. Partners can submit Remote MCP servers through the IBM Concierge web form or manual submission for BYOL catalog listing.

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. Partners can list their MCP servers in the catalog using either the IBM Concierge web form or manual submission process.

Submission Methods

Choose the submission method that best fits your needs:
  • IBM Concierge Web Form: Recommended for most partners. Submit through the IBM Concierge app with guided form fields.
  • Manual Submission (BYOL): For Bring Your Own License scenarios or partners who prefer email submission. Send completed materials to IBMAgentConnect@ibm.com.

Prerequisites

Before submitting your MCP server, ensure you have:
  • Remote MCP server: A functioning Remote MCP server endpoint
  • MCP specification: Completed Partner MCP Template JSON file
  • APP_ID: Unique identifier provided by IBM Ecosystem team
  • 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)

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 .

Submission Process

To submit your MCP server, follow the steps below:
1

Request APP_ID from IBM Ecosystem team

Contact the IBM Ecosystem team to request your APP_ID:
  • Email: IBMAgentConnect@ibm.com
  • Subject: “MCP APP_ID Request - [Your Company Name]”
  • Include: Company name, MCP server name, and brief description
The APP_ID will be communicated before submission and must be embedded in the JSON file.
2

Complete the MCP specification file

Copy and complete the Partner MCP Template JSON file with your MCP server details:Required fields:
  • publisher: Your company name
  • name: Unique programmatic MCP server name
  • display_name: User-friendly name for the catalog tile
  • description: Detailed description of your MCP server capabilities
  • version: MCP version (e.g., “0.0.1”)
  • icon: Inline SVG string for square icon (recommended 64×64px)
  • language_support: Supported languages (e.g., [“English”])
  • tags: 1-3 catalog categories (Customer Care, Finance, Healthcare, HR, Legal, News, Procurement, Productivity, Research, Sales, Security, Talent Management)
  • mcp.server_url: Your Remote MCP server endpoint URL
  • mcp.transport: Transport type (“streamable_http” or “sse”)
  • mcp.applications.app_id: Your assigned APP_ID
  • related_links: Support and Terms & Conditions links (mandatory)
Template structure:
Partner_MCP_Template.json
{
    // Your Company name
    "publisher": "Partner Name",

	// MCP Programmatic name
    "name": "unique_mcp_server_name",

	// MCP Display (User-Friendly) Name for the Catalog tile
    "display_name": "Friendly mcp server name",
	
    // Please provide a detailed description of your MCP Server
    "description": "The XYZ MCP Server enables seamless integration between third-party applications and our orchestration environment by exposing a set of structured, reliable tools through the Model Context Protocol. It supports multiple operations—including data retrieval, task execution, and workflow automation—while ensuring secure access through API-key and OAuth-based authentication. The server is designed for high availability and low latency, providing builders with a consistent interface to incorporate XYZ platform capabilities into their automated workflows. Comprehensive logging, error handling, and versioned endpoints ensure predictable behavior and simplified maintenance for development teams.",
	
    // MCP version
    "version": "0.0.1",
    "icon": "<svgAsString>",

    // Supported languages
	"language_support": [
		"English"
	],
    // Please list at least one catalog category (maximum of three).
	"tags": [
        "Customer Care",
        "Finance",
        "Healthcare",
        "HR",
        "Legal",
        "News",
        "Procurement",
		"Productivity",
		"Research",
        "Sales",
        "Security",
        "Talent Management"
	],

    // MCP URL and transport (select 'streamable_http' or 'sse')
	"mcp": {
		"server_url": "https://my-mcp-server/mcp",
		"transport": "streamable_http|sse",
		"tools": [
			"*"
		],
		"connections": {
			"name": "Object not needed. Entire connection object is injected at runtime by utilizing the app_id"
		},
		"applications": [
			{
                // If you were provided an app_id, replace 123abcd4 with your app_id.
				"app_id": "my_server_key_value_partner_123abcd4",
				"name": "Friendly app name",
				"icon": "<svgAsString>", // Same icon as above
                // Please specify your supported authentication schemas
                "security_schema": { 
					"auth type 1": {},
					"auth type 2": {}
				}
			}
		],

	},
 
    // Please add valid URLs. The Support and Terms & Conditions links are mandatory.
    // For Terms and Conditions, add link to your end-customer EULA
	"related_links": [
		{
			"key": "Support",
			"value": "<link1>",
			"type": "hyperlink"
		},
        		{
			"key": "Terms and Conditions",
			"value": "<link5>",
			"type": "hyperlink"
		},
		{
			"key": "Demo",
			"value": "<link2>",
			"type": "embedded"
		},
		{
			"key": "Documentation",
			"value": "<link3>",
			"type": "hyperlink"
		},
		{
			"key": "Training",
			"value": "<link4>",
			"type": "embedded"
		}

	],
    
    // Do Not Edit Below this line ------------------
	"category": "mcp_server",
	"kind": "external",
	"bundled": false,
    "change_log": ["string", "string", "string"],
	"delete_by": "2999-01-01"
}
The template includes inline comments guiding you through each required field. Replace placeholder values with your actual MCP server information.
3

Prepare submission materials

Gather all required materials:Submission checklist:
  • ✅ Completed MCP specification JSON file
  • ✅ Link to MCP setup documentation
  • ✅ At least one use case for IBM testing
  • ✅ Test credentials for creating connections
The APP_ID will be embedded in the JSON file.
4

Submit via email

Email your submission to IBMAgentConnect@ibm.com with:
  • Subject: “MCP Manual Submission - [Company Name] - [MCP Server Name]”
  • Attachments: Completed specification JSON file
  • Body: Include:
    • APP_ID (embedded in JSON)
    • Documentation links
    • Use case descriptions
    • Test credentials
    • Any special instructions
5

IBM validation and approval

IBM will follow the same validation process as web form submissions:
  1. Review submission completeness
  2. Validate functionality and connectivity
  3. Test use cases with provided credentials
  4. Approve for catalog listing
Timeline: Validation typically takes 5-7 business days

What Happens After Approval

Once your MCP server is approved:
  1. Catalog listing: Your MCP server appears in the watsonx Orchestrate catalog as a distinct listing type
  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. Usage tracking: Monitor adoption and usage through IBM Ecosystem team reports

Updating Your MCP Server

To update your MCP server listing:
  1. Increment the version number in your specification file
  2. Update relevant fields (description, documentation links, etc.)
  3. Resubmit via email (for manual submissions)
  4. Include update notes explaining changes
The same validation process applies to updates.

Troubleshooting

Common Issues

app id not received:
  • Contact IBMAgentConnect@ibm.com with subject “app id Request - [Company Name]”
  • Allow 2-3 business days for app id assignment
Specification validation errors:
  • Verify JSON syntax is correct
  • Ensure all required fields are populated
  • Check that app id matches the one provided by IBM
  • Validate URLs are properly formatted and accessible
Authentication 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 submission
Connection 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

Need Help?

For questions or support:
  • Email: IBMAgentConnect@ibm.com
  • Subject format: “MCP Support - [Your Company Name] - [Issue Type]”
  • Include: MCP server name, app id, error messages, and relevant details
Useful resources: