-
Notifications
You must be signed in to change notification settings - Fork 447
docs: MCP streamable HTTP endpoint instead of PyPI package #1712
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
6a42c5e
Document built-in MCP server and update refs
edwinjosechittilappilly 9cfed15
Rename MCP server key to openrag
edwinjosechittilappilly 5530184
Unify MCP docs: remove tabs, add IBM Bob link
edwinjosechittilappilly 8f972a4
peer review
aimurphy 26e75be
Merge branch 'main' into fix-docs-draft-mcp
aimurphy 7e4dc2a
Merge branch 'main' into fix-docs-draft-mcp
aimurphy File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,12 +1,18 @@ | ||
| --- | ||
| title: OpenRAG SDKs | ||
| title: OpenRAG SDK and MCP API references | ||
| slug: /reference/api-sdk-overview | ||
| --- | ||
|
|
||
| Use the OpenRAG SDKs to interact with OpenRAG programmatically or integrate OpenRAG into an application: | ||
|
|
||
| * [OpenRAG MCP Server](https://github.com/langflow-ai/openrag/tree/main/sdks/mcp) | ||
| * [Python SDK README](https://github.com/langflow-ai/openrag/tree/main/sdks/python) | ||
| * [TypeScript/JavaScript SDK README](https://github.com/langflow-ai/openrag/tree/main/sdks/typescript) | ||
| * [MCP API (streamable-HTTP endpoint)](https://github.com/langflow-ai/openrag/tree/main/sdks/mcp) | ||
|
|
||
| For the core APIs, see [`main.py`](https://github.com/langflow-ai/openrag/blob/main/src/main.py) | ||
| Connect your MCP client directly to your running OpenRAG instance at `/mcp`. | ||
|
|
||
| The standalone `openrag-mcp` package is deprecated; use the built-in endpoint instead. | ||
|
|
||
| * [Python SDK](https://github.com/langflow-ai/openrag/tree/main/sdks/python) | ||
|
|
||
| * [TypeScript/JavaScript SDK](https://github.com/langflow-ai/openrag/tree/main/sdks/typescript) | ||
|
|
||
| * [Core OpenRAG APIs (`main.py`)](https://github.com/langflow-ai/openrag/blob/main/src/main.py) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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.