Skip to main content

OpenRAG MCP — Final Release Notice

This package (openrag-mcp) has been retired.

OpenRAG now ships a built-in Model Context Protocol server over streamable HTTP — no subprocess, no separate install, no API key in a subprocess env block. Connect your MCP client directly to your running OpenRAG instance.

The last published version of openrag-mcp on PyPI is the final release. No further updates will be made to this package.


Migrating to streamable HTTP

The OpenRAG backend exposes an MCP endpoint at /mcp using the streamable-HTTP transport. Any MCP client that supports "url"-based server configs (Cursor, Claude Desktop, and the MCP SDK) can connect to it directly.

Prerequisites

  • A running OpenRAG instance (v0.3.0 or later)
  • An OpenRAG API key — create one in Settings → API Keys

Cursor

Config file: ~/.cursor/mcp.json

Standard API key:

{
  "mcpServers": {
    "openrag": {
      "url": "https://your-openrag-instance.com/mcp",
      "headers": {
        "X-API-Key": "orag_your_api_key_here"
      }
    }
  }
}

IBM auth (when IBM_AUTH_ENABLED=true on the server):

{
  "mcpServers": {
    "openrag": {
      "url": "https://your-openrag-instance.com/mcp",
      "headers": {
        "X-Username": "your_ibm_username",
        "X-Api-Key": "your_ibm_api_key"
      }
    }
  }
}

Restart Cursor after saving the config.


Claude Desktop

macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
Windows: %APPDATA%\Claude\claude_desktop_config.json

Standard API key:

{
  "mcpServers": {
    "openrag": {
      "url": "https://your-openrag-instance.com/mcp",
      "headers": {
        "X-API-Key": "orag_your_api_key_here"
      }
    }
  }
}

IBM auth:

{
  "mcpServers": {
    "openrag": {
      "url": "https://your-openrag-instance.com/mcp",
      "headers": {
        "X-Username": "your_ibm_username",
        "X-Api-Key": "your_ibm_api_key"
      }
    }
  }
}

Restart Claude Desktop after editing the file.


Available tools

All tools are auto-exposed from the /v1/ API and are available immediately after connecting:

Tool Description
openrag_chat Send a message and get a RAG-enhanced response. Supports chat_id and filter_id.
openrag_list_chats List all chat conversations.
openrag_get_chat Get a specific chat conversation by ID.
openrag_delete_chat Delete a chat conversation by ID.
openrag_search Semantic search over the knowledge base. Supports filters, score threshold, data sources.
openrag_ingest Ingest documents (files, URLs, text) into the knowledge base. Returns a task_id.
openrag_get_task_status Check the status of an ingestion task by task_id.
openrag_delete_document Delete a document from the knowledge base by filename.
openrag_get_settings Get current OpenRAG configuration (LLM, embeddings, chunk settings, system prompt).
openrag_update_settings Update OpenRAG configuration. All fields are optional.
openrag_list_models List available models for a provider (openai, anthropic, ollama, watsonx).
openrag_create_knowledge_filter Create a knowledge filter to scope searches and chats.
openrag_search_knowledge_filters Search knowledge filters by name or criteria.
openrag_get_knowledge_filter Get a knowledge filter by ID.
openrag_update_knowledge_filter Update an existing knowledge filter.
openrag_delete_knowledge_filter Delete a knowledge filter by ID.

Why streamable HTTP?

  • No subprocess — your MCP client connects over HTTP; nothing to install or spawn locally.
  • Full tool surface — document ingestion, task tracking, and knowledge filters are available from day one (previously listed as "coming later" in the stdio package).
  • One auth model — the same API key or IBM credentials you use for the REST API work for MCP.
  • Self-hosted and secure — the /mcp endpoint is part of your OpenRAG deployment; nothing leaves your network.

License

Apache 2.0 — see LICENSE for details.

Metadata

Release files for openrag-mcp 0.3.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for openrag-mcp 0.3.0
File Size Uploaded
openrag_mcp-0.3.0.tar.gz 3.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for openrag-mcp 0.3.0
File Interpreter ABI Platform
openrag_mcp-0.3.0-py3-none-any.whl Python 3 none any Details

Total release size: 6.0 kB

Release files / openrag_mcp-0.3.0.tar.gz

Download URL openrag_mcp-0.3.0.tar.gz
Size 3.0 kB
Tags Source
SHA-256 checksum
How to use checksums
12e32d65c8d925ccdc25fb38211119a6c29f21e90854f31c1d45809fde8f9818
BLAKE2b-256 checksum
How to use checksums
0310a04bdc94aeb1c03f9064f821064b5c179cfacdddbb6c13b06587a3b562d9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.11.16 {"installer":{"name":"uv","version":"0.11.16","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / openrag_mcp-0.3.0-py3-none-any.whl

Download URL openrag_mcp-0.3.0-py3-none-any.whl
Size 3.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
54c3f9536bd43518a1f77f10a0d4d537a82b34a2f4df56e592c052f63e749b12
BLAKE2b-256 checksum
How to use checksums
2fe769fc33c9ba63a2ab44c8c7d32192c870008b75da8e9ecc60ff30426ebebb
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.11.16 {"installer":{"name":"uv","version":"0.11.16","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page