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:
-
Log in to your watsonx.data web console.
-
From the navigation menu, select Configurations and click MCP server.
-
From the MCP configuration section, select the appropriate option based on your host type.
-
Copy the complete configuration snippet displayed. The snippet includes all required credentials except the Base64-encoded key.
-
Create the Base64-encoded key:
- 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.
- Transform your API key into a Base64-encoded value as described in Creating a base64 credential string.
- 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:
-
Log into IBM Cloud.
-
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. -
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 -
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/... -
Create the Base64-encoded key:
- If you do not have an existing API key, create your API key. For more information, see Creating an API key.
- Transform your API key into a Base64-encoded value as described in Creating a base64 credential string.
-
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 -
Windows PowerShell
[Convert]::ToBase64String([Text.Encoding]::ASCII.GetBytes("ibmlhapikey_<your-email>:<your-apikey>"))
Configuring the host
After obtaining the configuration information, you need to add it to your host's configuration file.
-
The IBM Bob configuration file is:
~/Library/Application Support/Bob-IDE/User/globalStorage/ibm.bob-code/settings/mcp_settings.json -
The Claude Desktop configuration file location varies by operating system:
Configuration file location Operating System Configuration File Path macOS ~/Library/Application Support/Claude/claude_desktop_config.jsonWindows %APPDATA%\Claude\claude_desktop_config.jsonLinux ~/.config/Claude/claude_desktop_config.json -
For other hosts, you must determine the appropriate file for the local MCP server configuration.
To configure the host:
-
Open the configuration file in a text editor.
-
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>" ] } } }
-
-
Save the file.
-
Restart the host.
Next steps
- Configure tools: For detailed information on MCP tools and their usage, see https://github.com/IBM/ibm-watsonxdata-mcp-server/blob/main/TOOLS.md.