Skip to content

docs: MCP streamable HTTP endpoint instead of PyPI package#1712

Merged
aimurphy merged 6 commits into
mainfrom
fix-docs-draft-mcp
May 29, 2026
Merged

docs: MCP streamable HTTP endpoint instead of PyPI package#1712
aimurphy merged 6 commits into
mainfrom
fix-docs-draft-mcp

Conversation

@edwinjosechittilappilly

@edwinjosechittilappilly edwinjosechittilappilly commented May 29, 2026

Copy link
Copy Markdown
Collaborator

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

  • Documentation
    • Updated MCP server configuration to use the built-in streamable HTTP endpoint at /mcp instead of external packages
    • Deprecated the standalone openrag-mcp package
    • Added simplified setup instructions with updated configuration examples for Cursor and Claude Desktop using direct URL and API key authentication
    • Revised documentation labels and structure to reflect the new MCP architecture

Review Change Stack

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.
@github-actions github-actions Bot added documentation 📘 Improvements or additions to documentation and removed documentation 📘 Improvements or additions to documentation labels May 29, 2026
@edwinjosechittilappilly

Copy link
Copy Markdown
Collaborator Author

@aimurphy Can you take a look at this PR once available and help us to modify this wrt to docs requirement ?

@coderabbitai

coderabbitai Bot commented May 29, 2026

Copy link
Copy Markdown
Contributor

Walkthrough

This pull request updates OpenRAG's documentation to reflect a built-in MCP server served over streamable HTTP at /mcp. The changes deprecate the standalone openrag-mcp PyPI package, update client configuration examples for Cursor and Claude Desktop, and restructure reference documentation to describe the new authentication and endpoint details.

Changes

MCP Server Documentation Updates

Layer / File(s) Summary
Root README MCP documentation
README.md
Updated the README's MCP section to document the built-in /mcp streamable-HTTP server authenticated via X-API-Key, removed legacy openrag-mcp installation instructions, and changed the full documentation link to the GitHub docs page.
API/SDK reference documentation structure
docs/docs/reference/api-sdk-overview.mdx, docs/sidebars.js
Renamed the page title to "OpenRAG SDK and MCP API references" and restructured the MCP content bullets to emphasize the /mcp streamable-HTTP endpoint with a deprecation notice for the standalone openrag-mcp package; updated the sidebar navigation label consistently.
MCP client setup and configuration guide
sdks/mcp/README.md
Comprehensive update adding a deprecation notice for the openrag-mcp package, rewriting prerequisites and authentication guidance, updating Cursor configuration examples, streamlining Claude Desktop configuration, adding a new IBM Bob streamable-HTTP configuration section, and relocating the Apache 2.0 license statement.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • langflow-ai/openrag#1668: Parallels this PR by updating openrag-mcp MCP documentation to retire the standalone package and direct users to the built-in streamable-HTTP MCP endpoint at /mcp with new Cursor/Claude client configurations.

Suggested reviewers

  • phact
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the primary change: transitioning MCP documentation from a deprecated PyPI package to OpenRAG's built-in streamable HTTP endpoint.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix-docs-draft-mcp

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions

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.
@github-actions github-actions Bot added documentation 📘 Improvements or additions to documentation and removed documentation 📘 Improvements or additions to documentation labels May 29, 2026
@github-actions

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.
@github-actions github-actions Bot added documentation 📘 Improvements or additions to documentation and removed documentation 📘 Improvements or additions to documentation labels May 29, 2026
@github-actions

This comment has been minimized.

@aimurphy aimurphy left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

discussed on Slack

Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread docs/docs/reference/api-sdk-overview.mdx Outdated
Comment thread docs/docs/reference/mcp.mdx Outdated
Comment thread docs/sidebars.js Outdated
Comment thread docs/docs/reference/api-sdk-overview.mdx Outdated
Comment thread docs/sidebars.js Outdated
@github-actions github-actions Bot added documentation 📘 Improvements or additions to documentation and removed documentation 📘 Improvements or additions to documentation labels May 29, 2026
@github-actions

This comment has been minimized.

@aimurphy aimurphy changed the title docs: [Draft] Document built-in MCP server and update refs docs: MCP streamable HTTP endpoint instead of PyPI package May 29, 2026
@github-actions github-actions Bot removed the documentation 📘 Improvements or additions to documentation label May 29, 2026
@aimurphy
aimurphy requested a review from mendonk May 29, 2026 16:23
@github-actions github-actions Bot added the documentation 📘 Improvements or additions to documentation label May 29, 2026
@aimurphy
aimurphy marked this pull request as ready for review May 29, 2026 16:23
@github-actions github-actions Bot added documentation 📘 Improvements or additions to documentation and removed documentation 📘 Improvements or additions to documentation labels May 29, 2026
@aimurphy
aimurphy dismissed their stale review May 29, 2026 16:24

I am the assignee

@github-actions github-actions Bot added documentation 📘 Improvements or additions to documentation and removed documentation 📘 Improvements or additions to documentation labels May 29, 2026
@github-actions

This comment has been minimized.

@github-actions github-actions Bot added documentation 📘 Improvements or additions to documentation and removed documentation 📘 Improvements or additions to documentation labels May 29, 2026

@mendonk mendonk left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1

@github-actions github-actions Bot added the lgtm label May 29, 2026
Copilot AI review requested due to automatic review settings May 29, 2026 16:51
@github-actions github-actions Bot added documentation 📘 Improvements or additions to documentation and removed documentation 📘 Improvements or additions to documentation labels May 29, 2026
@github-actions

github-actions Bot commented May 29, 2026

Copy link
Copy Markdown
Contributor

Build successful! ✅
Deploying docs draft.
Deploy successful! View draft

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread README.md
```bash
pip install openrag-mcp
```
> **Important:** The standalone `openrag-mcp` PyPI package is deprecated. Connect your MCP client directly to the `/mcp` endpoint instead.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Edwin will investigate these as part of deprecating the pypi package.

@aimurphy
aimurphy merged commit 8f4e663 into main May 29, 2026
13 checks passed
@github-actions
github-actions Bot deleted the fix-docs-draft-mcp branch May 29, 2026 17:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation 📘 Improvements or additions to documentation lgtm

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Docs]: streamable http support in mcp sdk

4 participants