Skip to main content

An IBM watsonx.governance mcp server that connects AI agents with marketplace of tools available on governance catalog

Project description

ibm-watsonx-gov-catalog-mcp-server

The ibm-watsonx-gov-catalog-mcp-server is a Model Context Protocol (MCP)-compliant server that seamlessly connects AI agents with tools hosted on watsonx governed agentic catalog.


Overview

  • Protocol: Model Context Protocol (MCP)
  • Purpose: Acts as a bridge between agentic AI frameworks and tools on governance catalog
  • Supported Environments: Watsonx SaaS (Envs Supported : Sydney , Toronto)
  • Agent Compatibility: The agentic framework must support the MCP standard (via Stdio).
    Note: This server will not function with agents that do not support MCP.

Prerequisites

  • Python version 3.11 or later
  • Access to your SaaS environment
  • Ensure your Agent framework supports MCP protocol


Setup

Step 1: Install Python

Step 2: Create a virtual environment

python -m venv .venv

Running the Server

uv run ibm-watsonx-gov-catalog-mcp-server

Step 3: Activate the virtual environment

source .venv/bin/activate  # macOS/Linux
.venv\Scripts\activate     # Windows

Step 4: Install the uv package manager

pip install uv


Build the wheel file

uv pip install build
uv run python -m build 

Build and Run the server

uv run ibm-watsonx-gov-catalog-mcp-server

Testing using MCP Inspector

Set the following environment variables

For Watsonx SaaS

If you have not already, provision an instance of IBM WatsonX Governance instance using the link in the Cloud catalog .

export WATSONX_APIKEY=<API KEY>
export WATSONX_REGION=<WATSONX_REGION>

NOTE:

  • For WATSONX_APIKEY: This is required for IBM watsonx.governance capabilities. Your Cloud API key can be generated by going to the Users section of the Cloud console. From that page, click your name, scroll down to the API Keys section, and click Create an IBM Cloud API key. Give your key a name and click Create, then copy the created key and paste it below.

  • For WATSONX_REGION: Set if you are using IBM watsonx.governance as a service in a regional data center other than default Dallas (us-south), in Texas US. Supported region values are "us-south", "eu-de", "au-syd", "ca-tor", "jp-tok".

Invoke MCP inspector

npx @modelcontextprotocol/inspector uv run ibm-watsonx-gov-catalog-mcp-server -e WATSONX_APIKEY=<WASONX_APIKEY> -e WATSONX_REGION=<WATSONX_REGION>

Limitations

  • Environment credentials cannot be changed during runtime.
    • To change credentials, either:
      • Start a new server with new env variables
  • Transport types supported : stdio
  • Tool call is supported : OOTB tools , Tools created using custom code .

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file ibm_watsonx_gov_catalog_mcp_server-1.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for ibm_watsonx_gov_catalog_mcp_server-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 feabdf2ca0548637a4ed86bdc54ceb2f32082bc4ff6d4d59759a3b4e281757c1
MD5 0449891b4c5aed75bf21d09b168db269
BLAKE2b-256 310e29b67bfe561e04511ade095cc470d12ab6a06cce991fe211b2e0705c4a66

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page