Setting up the remote MCP server

To set up the remote MCP server with your local host, you add the MCP server information to the host configuration file. You can obtain the configuration information from the watsonx.data web console (recommended) or manually gather it from IBM Cloud.

Getting the required credentials and instance information

You can obtain the required MCP server credentials and instance information by using one of the following options:
Getting configuration from the web console
You can obtain the MCP URL endpoint, instance CRN, and pre-configured code snippets directly from the watsonx.data web console.
To get the configuration from the web console:
  1. Log in to your watsonx.data web console.
  2. From the navigation menu, select Configurations and click MCP server.
  3. From the MCP configuration section, select the appropriate option based on your host type.
  4. Copy the complete configuration snippet displayed. The snippet includes all required credentials except the Base64-encoded key.
  5. Create the Base64-encoded key:
    1. If you do not have an existing API key, click API key to create your API key. For more information, see Creating an API key .
    2. Transform your API key into a Base64-encoded value. See the Creating a base64 credential string instructions below.
    3. Replace the <base64-encoded-value> placeholder in the configuration snippet with your encoded value.
Manually gathering configuration information
Alternatively, you can manually gather the required configuration information from IBM Cloud and build the configuration yourself.
You need to provide values for the following variables in the host configuration file:
  • The <console-host> portion of your watsonx.data instance URL for the MCP server endpoint, which has the following format:

    https://<console-host>/api/v1/watsonxdata/mcp

  • Your credentials:
    • Your IBM Cloud API key in a base64 credentials string OR your IBM Cloud bearer token
  • The Cloud Resource Name (CRN) of your watsonx.data instance
To get your credentials and instance information:
  1. Log into IBM Cloud.
  2. To find the <console-host> and CRN values, go to Resources list from the navigation menu and select your watsonx.data instance from Database dropdown.
  3. Get the value of `\<console-host> by copying the first part of the web console URL. For example: console-ibm-cator.lakehouse.saas.ibm.com
  4. Get your watsonx.data instance CRN by copying the CRN value. The CRN has the following format: crn:v1:bluemix:public:lakehouse:us-south/a/...
  5. Create the Base64-encoded key:
    1. If you do not have an existing API key, create your API key. For more information, see Creating an API key.
    2. Transform your API key into a Base64-encoded value as described in Creating a base64 credential string.
  6. If you want to use your IBM Cloud bearer token as your authorization credentials, copy or generate your bearer token. See Generating an IBM Cloud IAM token by using an API key
Creating a base64 credential string
Open a terminal and run the following command, replacing the placeholders with your values:
  • Mac or Linux:
    echo -n "ibmlhapikey_<your-email>:<your-apikey>" | base64

    For example:

    echo -n "ibmlhapikey_user@example.com:abcd1234fakeapikey5678" | base64
  • Windows PowerShell:
    [Convert]::ToBase64String([Text.Encoding]::ASCII.GetBytes("ibmlhapikey_<your-email>:<your-apikey>"))

    For example:

    [Convert]::ToBase64String([Text.Encoding]::ASCII.GetBytes("ibmlhapikey_user@example.com:abcd1234fakeapikey5678"))

Configuring the host

After obtaining the configuration information, you need to add it to your host's configuration file.

IBM Bob configuration file

You can locate and open the IBM Bob configuration file by using one of the following methods:

Using the Bob IDE interface (recommended)

This method automatically opens the correct configuration file.

  1. Click the Settings icon (gear icon) in the Bob chat toolbar.
  2. The Bob Settings panel opens in a new editor tab. In the left sidebar, select MCP.
  3. Click the + (Add MCP server) icon in the top right of the server list, next to the search bar.
  4. Select Global (All Workspaces) from the Configuration Scope dropdown.
  5. Click Open Configuration File.

    The mcp.json configuration file opens in your editor, ready to edit.

Manually locating the file

The configuration file location varies depending on your IBM Bob version:

  • Standalone IBM Bob IDE and Bob Shell (current versions):
    ~/.bob/settings/mcp_settings.json
  • Older versions (installed as VS Code extension):
    ~/Library/Application Support/Bob-IDE/User/globalStorage/ibm.bob-code/settings/mcp_settings.json
Claude Desktop configuration file

The configuration file location varies by operating system:

Table 1. Configuration file location
Operating system Configuration file path
macOS ~/Library/Application Support/Claude/claude_desktop_config.json
Windows %APPDATA%\Claude\claude_desktop_config.json
Linux ~/.config/Claude/claude_desktop_config.json
Note: For other hosts, you must determine the appropriate file for the local MCP server configuration.

To configure the host:

  1. Open the configuration file in a text editor.
  2. Add the configuration:
    • If you used the web console: Paste the complete configuration snippet you copied from the web console.
    • If you manually gathered the information: Add the appropriate configuration based on your host type and credentials, and replace the placeholder values with your actual credentials gathered from IBM Cloud:
      For Bob and other MCP-compatible hosts (using API credentials):
      {
             "mcpServers": {
               "watsonx.data-mcp-server": {
                 "type": "streamable-http",
                 "url": "https://<console-host>/api/v1/watsonxdata/mcp",
                 "headers": {
                   "authorization": "Basic <base64-encoded-value>",
                   "authinstanceid": "<YOUR_WATSONXDATA_INSTANCE_CRN>"
                 }
               }
             }
           }
      For Claude (using API credentials):
           {
             "mcpServers": {
               "watsonx.data-mcp-server": {
                 "command": "npx",
                 "args": [
                   "mcp-remote",
                   "https://<console-host>/api/v1/watsonxdata/mcp",
                   "--header",
                   "authorization: Basic <base64-encoded-value>",
                   "--header",
                   "authinstanceid: <YOUR_WATSONXDATA_INSTANCE_CRN>"
                 ]
               }
             }
           }
      For Claude and Bob (using bearer token):
      {
             "mcpServers": {
               "watsonx.data-mcp-server": {
                 "command": "npx",
                 "args": [
                   "mcp-remote",
                   "https://<console-host>/api/v1/watsonxdata/mcp",
                   "--header",
                   "authorization: Bearer <YOUR_TOKEN>",
                   "--header",
                   "authinstanceid: <YOUR_WATSONXDATA_INSTANCE_CRN>"
                 ]
               }
             }
           }
  3. Save the file.
  4. Restart the host.

Next steps

For detailed information on MCP tools and their usage, see TOOLS.md.