Integrating with watsonx Orchestrate

You can integrate local MCP server with watsonx Orchestrate using one of the following method:

Transport stdio

Complete the following steps to integrate the local MCP server with watsonx Orchestrate using transport stdio:

  1. Install IBM watsonx Orchestrate Agent Development Kit (ADK) and complete the initial setup. For more information, refer Welcome to IBM watsonx Orchestrate Agent Development Kit.

  2. Run the following command to create connection.

    orchestrate connections add -a <app id>

  3. Run the following command to configure connection.

    orchestrate connections configure --app-id <app id> --environment draft -t team -k key_value

  4. Run the following command to set credentials.

    export CPD_ENDPOINT="<cpd-endpoint>"
export CPD_USERNAME="<cpd-username>"
export CPD_PASSWORD="<cpd-password>"
export CA_BUNDLE_PATH="<absolute_path_to_cabundle.crt>"
export LH_CONTEXT="CPD"

  5. Add the tools as toolkit in watsonx Orchestrate. For more information, refer Managing Toolkits.

    The following example demonstrates how to add tools as a toolkit in watsonx Orchestrate.

    orchestrate toolkits import \
  --kind mcp \
  --name mcp_toolkit \
  --description "mcp server for watsonx retrival service" \
  --package "ibm-watsonxdata-dl-retrieval-mcp-server" \
  --command "uvx ibm-watsonxdata-dl-retrieval-mcp-server --transport stdio" \
  --language python \
  --tools "*" \
  --app-id <app id>

Transport sse

Complete the following steps to integrate the local MCP server with watsonx Orchestrate using transport sse:

  1. Install IBM watsonx Orchestrate Agent Development Kit (ADK) and complete the initial setup. For more information, refer Welcome to IBM watsonx Orchestrate Agent Development Kit.

  2. Run the following commands to install mcp-proxy.

    pip install mcp-proxy

  3. Run ibm-watsonxdata-dl-retrieval-mcp-server in sse transport.

  4. Add the tools as toolkit in watsonx Orchestrate. For more information, refer Managing Toolkits.

    The following example demonstrates how to add tools as a toolkit in watsonx Orchestrate.

    orchestrate toolkits import \
  --kind mcp \
  --name mcp_toolkit \
  --description "MCP server (hosted, SSE)" \
  --package "mcp-proxy" \
  --language python \
  --command "uvx mcp-proxy https://<mcp server endpoint>/sse" \
  --tools "*"

Parent topic: IBM watsonx.data Model Context Protocol (MCP) server