Skip to content

OpenRAG is a comprehensive, single package Retrieval-Augmented Generation platform built on Langflow, Docling, and Opensearch.

Python

feat: MCP SaaS updates for new headers (#1365)

Mike Fortman7b9737fe2f73
diff --git a/sdks/mcp/pyproject.toml b/sdks/mcp/pyproject.toml
index ade94d08d..201d98f6b 100644
--- a/sdks/mcp/pyproject.toml
+++ b/sdks/mcp/pyproject.toml
@@ -1,6 +1,6 @@
[project]
name = "openrag-mcp"
-version = "0.2.2"
+version = "0.3.0rc1"
description = "MCP server for OpenRAG"
readme = "README.md"
requires-python = ">=3.10"
@@ -23,7 +23,7 @@ classifiers = [
dependencies = [
"mcp>=1.0.0",
"httpx>=0.27.0",
- "openrag-sdk>=0.1.0",
+ "openrag-sdk==0.3.0rc1",
]
[project.scripts]
diff --git a/sdks/mcp/src/openrag_mcp/config.py b/sdks/mcp/src/openrag_mcp/config.py
index b588f34d3..856ea763b 100644
--- a/sdks/mcp/src/openrag_mcp/config.py
+++ b/sdks/mcp/src/openrag_mcp/config.py
@@ -44,7 +44,17 @@ class Config:
self.openrag_url = os.environ.get("OPENRAG_URL", "http://localhost:3000")
self.api_key = os.environ.get("OPENRAG_API_KEY")
- if not self.api_key:
+ # IBM auth mode: user provides IBM_USERNAME + IBM_API_KEY instead of OPENRAG_API_KEY.
+ # The MCP forwards these as headers on every SDK request to OpenRAG.
+ ibm_username = os.environ.get("IBM_USERNAME")
+ ibm_api_key = os.environ.get("IBM_API_KEY")
+ self.ibm_extra_headers: dict[str, str] = {}
+ if ibm_username:
+ self.ibm_extra_headers["X-Username"] = ibm_username
+ if ibm_api_key:
+ self.ibm_extra_headers["X-Api-Key"] = ibm_api_key
+
+ if not self.api_key and not self.ibm_extra_headers:
raise ValueError(
"OPENRAG_API_KEY environment variable is required. "
"Create an API key in OpenRAG Settings > API Keys."
@@ -62,10 +72,10 @@ class Config:
@property
def headers(self) -> dict[str, str]:
"""Get HTTP headers for API requests."""
- return {
- "X-API-Key": self.api_key,
- "Content-Type": "application/json",
- }
+ headers: dict[str, str] = {"Content-Type": "application/json"}
+ if self.api_key:
+ headers["X-API-Key"] = self.api_key
+ return headers
_config: Config | None = None
@@ -84,8 +94,11 @@ def get_openrag_client() -> OpenRAGClient:
"""Get singleton OpenRAGClient instance."""
global _openrag_client
if _openrag_client is None:
- # OpenRAGClient reads OPENRAG_API_KEY and OPENRAG_URL from env
- _openrag_client = OpenRAGClient()
+ config = get_config()
+ _openrag_client = OpenRAGClient(
+ api_key=config.api_key,
+ extra_headers=config.ibm_extra_headers or None,
+ )
return _openrag_client
diff --git a/sdks/mcp/uv.lock b/sdks/mcp/uv.lock
index a15b0d1a4..3c9dff6d1 100644
--- a/sdks/mcp/uv.lock
+++ b/sdks/mcp/uv.lock
@@ -332,7 +332,7 @@ wheels = [
[[package]]
name = "openrag-mcp"
-version = "0.2.2"
+version = "0.3.0rc1"
source = { editable = "." }
dependencies = [
{ name = "httpx" },
@@ -344,20 +344,20 @@ dependencies = [
requires-dist = [
{ name = "httpx", specifier = ">=0.27.0" },
{ name = "mcp", specifier = ">=1.0.0" },
- { name = "openrag-sdk", specifier = ">=0.1.0" },
+ { name = "openrag-sdk", specifier = "==0.3.0rc1" },
]
[[package]]
name = "openrag-sdk"
-version = "0.1.0"
+version = "0.3.0rc1"
source = { registry = "https://pypi.org/simple" }
dependencies = [
{ name = "httpx" },
{ name = "pydantic" },
]
-sdist = { url = "https://files.pythonhosted.org/packages/d7/9e/7a10ddb6742417970163d11aed40146bb3340532f17c1099434d8667a4e0/openrag_sdk-0.1.0.tar.gz", hash = "sha256:cf99fddf254c6c72295c73498877c56f68287d33a072ca2171f490de7df8617e", size = 17116, upload-time = "2025-12-18T05:24:47.588Z" }
+sdist = { url = "https://files.pythonhosted.org/packages/38/17/4f5b489616d8a91e8782c725bd40944a6ed904384b10d63c58d0261909d4/openrag_sdk-0.3.0rc1.tar.gz", hash = "sha256:91e824ce9accbf2fb818d33b92f3743d72e59659be1ffe5938c5a83cfa8cc799", size = 15442, upload-time = "2026-04-09T18:50:15.94Z" }
wheels = [
- { url = "https://files.pythonhosted.org/packages/74/3c/6962d87b8b4604ef8cf776bf7d4e416a0025d5f08f5400ecc47b35616ae0/openrag_sdk-0.1.0-py3-none-any.whl", hash = "sha256:6b99be26b64a61e2347a4ce8f530b673a119d59bfe11ff5ead6318b9a3fb9dac", size = 15756, upload-time = "2025-12-18T05:24:46.231Z" },
+ { url = "https://files.pythonhosted.org/packages/21/5a/95add758ec61894089b94387896b41d53262ec846625dbc74e7c583aa764/openrag_sdk-0.3.0rc1-py3-none-any.whl", hash = "sha256:0905994e48aa279636013536087ab69d3f1c1a9895bf22602c4ddcd85a90d562", size = 16624, upload-time = "2026-04-09T18:50:14.861Z" },
]
[[package]]
diff --git a/src/dependencies.py b/src/dependencies.py
index a4cba9097..c349af298 100644
--- a/src/dependencies.py
+++ b/src/dependencies.py
@@ -335,15 +335,36 @@ async def get_api_key_user_async(
session_manager=Depends(get_session_manager),
) -> User:
"""
- Async dependency: require API key authentication.
+ Async dependency: require API key or IBM authentication.
Accepts:
- X-API-Key: orag_... header
- Authorization: Bearer orag_... header
+ - X-Username + X-Api-Key headers (when IBM_AUTH_ENABLED)
- Raises HTTP 401 if no valid key is provided.
+ Raises HTTP 401 if no valid credentials are provided.
"""
- # Extract key from headers
+ from config.settings import IBM_AUTH_ENABLED
+
+ # IBM auth path: X-Username + X-Api-Key forwarded by the MCP via the SDK
+ if IBM_AUTH_ENABLED:
+ ibm_username = request.headers.get("X-Username")
+ ibm_api_key = request.headers.get("X-Api-Key")
+ if ibm_username and ibm_api_key:
+ user = User(
+ user_id=ibm_username,
+ email=ibm_username,
+ name=ibm_username,
+ picture=None,
+ provider="ibm_ams",
+ jwt_token=None,
+ opensearch_username=ibm_username,
+ opensearch_credentials=ibm_api_key,
+ )
+ request.state.user = user
+ return user
+
+ # API key path
api_key = request.headers.get("X-API-Key")
if not api_key or not api_key.startswith("orag_"):
auth_header = request.headers.get("Authorization", "")