Skip to main content

An IBM watsonx.data mcp server that seamlessly connects AI agents with document libraries

Project description

Watsonx.data Document Library Retrieval MCP Server

The Watsonx.data Document Library Retrieval MCP Server is a Model Context Protocol (MCP)-compliant service that seamlessly connects AI agents with document libraries in watsonx.data, enabling intelligent data retrieval and interaction.

Key Features

  • Dynamic Discovery & Registration
    Automatically detects and registers document libraries as MCP tools.

  • Natural Language Interface
    Query document libraries using conversational language and receive human-readable responses.

  • Minimal Configuration
    Deploy with simple setup requirements and zero complex configurations.

  • Framework-Agnostic Integration
    Plug directly into the preferred agentic frameworks with native MCP compatibility.


Overview

  • Protocol: Model Context Protocol (MCP)
  • Purpose: Acts as a bridge between agentic AI frameworks and watsonx.data document libraries
  • Supported Environments: IBM Cloud Pak for Data (CPD), Watsonx SaaS
  • Agent Compatibility: The agentic framework must support the MCP standard (via SSE or Stdio).
    Note: This server will not function with agents that do not support MCP.

Prerequisites

  • Python version 3.11 or later
  • Access to your CPD or SaaS environment
  • Access credentials and a CA certificate bundle for CPD
  • Ensure your agent framework supports MCP protocol

Getting CA Bundle for CPD

  1. Login to your OpenShift cluster:

    oc login -u kubeadmin -p '<your_openshift_password>' https://<your_openshift_cpd_url>:6443
    
  2. Extract the root CA bundle:

    oc get configmap kube-root-ca.crt -o jsonpath='{.data.ca\.crt}' > cabundle.crt
    

Setup

Step 1: Install Python

Step 2: Create a virtual environment

python -m venv .venv

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

Step 5: Install the MCP server package

pip install ibm-watsonxdata-dl-retrieval-mcp-server

Configuration

For Cloud Pak for Data (CPD):

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"

For Watsonx SaaS:

export WATSONX_DATA_API_KEY="<api-key>"
export WATSONX_DATA_RETRIEVAL_ENDPOINT="<retrieval-service-endpoint>"
export DOCUMENT_LIBRARY_API_ENDPOINT="<document-library-endpoint>"
export WATSONX_DATA_TOKEN_GENERATION_ENDPOINT="<token-generation-endpoint>"
export LH_CONTEXT="SAAS"

Running the Server

uv run ibm-watsonxdata-dl-retrieval-mcp-server

By default, the server runs in sse transport mode on port 8000.

Transport: SSE

uv run ibm-watsonxdata-dl-retrieval-mcp-server --port <desired_port> --transport sse

Transport: stdio

uv run ibm-watsonxdata-dl-retrieval-mcp-server --port <desired_port> --transport stdio

Integrating with Agentic Frameworks

This server supports standard MCP adapters, compatible with most modern agentic frameworks. These adapters expose tools via:

  • HTTP endpoints (e.g., http://localhost:8000/sse)
  • OR through stdio.

Example (Python + LlamaStack)

from llama_stack.distribution.library_client import LlamaStackAsLibraryClient
from llama_stack_client.types.toolgroup_register_params import McpEndpoint

client = LlamaStackAsLibraryClient("your-inference-provider")
client.initialize()

client.toolgroups.register(
    toolgroup_id="mcp::your_toolgroup",
    provider_id="model-context-protocol",
    mcp_endpoint=McpEndpoint(uri="http://localhost:8000/sse"),
)

Once registered, tools can be used as part of an agent definition:

from llama_stack_client import Agent

agent = Agent(
    client,
    model="your-model",
    instructions="...",
    tools=["mcp::your_toolgroup"],
)

📚 LlamaStack Docs – Model Context Protocol


Limitations

  • Environment credentials cannot be changed during runtime.
    • To change credentials, either:
      • Start a new server with new env variables, OR
      • Source new environment variables and restart the server.

Tool Naming

Each document library is registered with a unique tool name:

tool_name = <library_name><library_id>

Example:

invoice_document_library77e4b4dd_479e_4406_acc4_ce154c96266c

Project details


Download files

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

Source Distribution

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_watsonxdata_dl_retrieval_mcp_server-0.1.0.tar.gz.

File metadata

File hashes

Hashes for ibm_watsonxdata_dl_retrieval_mcp_server-0.1.0.tar.gz
Algorithm Hash digest
SHA256 f057ebc46d816e0ee8466d0cfb033eac96c3c50af884bec4da33f76df1277aab
MD5 414a5c2d9b8ea0fc87db06293a42fcf5
BLAKE2b-256 f14a442baa0384d4e5fd9445b0e2696f1af3444addfeaf21b5e12f0ba76bad8d

See more details on using hashes here.

File details

Details for the file ibm_watsonxdata_dl_retrieval_mcp_server-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for ibm_watsonxdata_dl_retrieval_mcp_server-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0d41218c16218a9c46b34b2927e1341e93b4fd1d8bc428c0cbe6790ca38cb728
MD5 2e50befe551352c2d633013c878a56bb
BLAKE2b-256 5fd025784ee0e76aa0eea84f89af43747cbb5d91b0ad609305e1107acc7a04e9

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