docs: MCP streamable HTTP endpoint instead of PyPI package#1712
Conversation
Add a new MCP reference doc describing the built-in Model Context Protocol (MCP) server (streamable-HTTP at /mcp), authentication via X-API-Key, client config examples (Cursor, Claude Desktop, IBM Bob), available tools, and rationale for using the endpoint. Deprecate the standalone openrag-mcp PyPI package and remove install/stdio instructions from README and SDK docs. Update API/SDK overview, docs sidebar, and sdks/mcp/README.md to point to the new doc and canonical /mcp usage and URLs.
|
@aimurphy Can you take a look at this PR once available and help us to modify this wrt to docs requirement ? |
WalkthroughThis pull request updates OpenRAG's documentation to reflect a built-in MCP server served over streamable HTTP at ChangesMCP Server Documentation Updates
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
This comment has been minimized.
This comment has been minimized.
Standardize the example MCP server identifier by changing "openrag-server-tp" to "openrag" in documentation. Updated files: docs/docs/reference/mcp.mdx and sdks/mcp/README.md to keep config examples consistent.
This comment has been minimized.
This comment has been minimized.
Replace tabbed UI in MCP documentation with simple headings for Cursor, Claude Desktop, and IBM Bob by removing Tabs/TabItem imports and markup. Add a link to IBM's MCP integration tutorial for IBM Bob in both docs/docs/reference/mcp.mdx and sdks/mcp/README.md to provide a step-by-step walkthrough and improve readability.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
|
Build successful! ✅ |
There was a problem hiding this comment.
Pull request overview
This PR updates MCP documentation to direct users to OpenRAG’s built-in streamable HTTP /mcp endpoint instead of the deprecated standalone openrag-mcp package.
Changes:
- Rewrites the MCP SDK README with endpoint URLs, auth guidance, client examples, and tool inventory.
- Updates root README MCP setup to use URL-based config with
X-API-Key. - Renames and adjusts the API/SDK overview and sidebar entry to include MCP API references.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
sdks/mcp/README.md |
Documents /mcp streamable HTTP usage, auth, client configs, and tools. |
README.md |
Replaces PyPI/stdio MCP setup with direct /mcp endpoint config. |
docs/sidebars.js |
Updates sidebar label for SDK/MCP references. |
docs/docs/reference/api-sdk-overview.mdx |
Updates overview links and deprecation messaging. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ```bash | ||
| pip install openrag-mcp | ||
| ``` | ||
| > **Important:** The standalone `openrag-mcp` PyPI package is deprecated. Connect your MCP client directly to the `/mcp` endpoint instead. |
There was a problem hiding this comment.
Edwin will investigate these as part of deprecating the pypi package.
Add a new MCP reference doc describing the built-in Model Context Protocol (MCP) server (streamable-HTTP at /mcp), authentication via X-API-Key, client config examples (Cursor, Claude Desktop, IBM Bob), available tools, and rationale for using the endpoint. Deprecate the standalone openrag-mcp PyPI package and remove install/stdio instructions from README and SDK docs. Update API/SDK overview, docs sidebar, and sdks/mcp/README.md to point to the new doc and canonical /mcp usage and URLs.
Closes #1407
Summary by CodeRabbit
/mcpinstead of external packagesopenrag-mcppackage