-
Notifications
You must be signed in to change notification settings - Fork 5.5k
Rev on hosted MCP docs #16754
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
Rev on hosted MCP docs #16754
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
Warning Rate limit exceeded@dannyroosevelt has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 23 minutes and 7 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ⛔ Files ignored due to path filters (1)
📒 Files selected for processing (1)
WalkthroughThe changes update documentation and configuration related to the MCP server, primarily replacing the MCP server URL with a new remote endpoint in code samples and documentation. The OpenAI property in the metadata file is simplified from an object to a string. Additional clarifications and restructuring are made to developer instructions and environment setup. Changes
Poem
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
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.
Actionable comments posted: 0
🧹 Nitpick comments (3)
docs-v2/pages/connect/mcp/openai.mdx (1)
132-132: Clarify cURL example variable interpolation
The quoting for$APP_SLUGinside the JSON payload may not expand as intended. Consider simplifying to:- "server_url": "https://remote.mcp.pipedream.net/abc-123/'$APP_SLUG'", + "server_url": "https://remote.mcp.pipedream.net/abc-123/$APP_SLUG",and adjust the surrounding single‐quote delimiters to ensure the shell variable is correctly interpolated.
docs-v2/pages/connect/mcp/developers.mdx (2)
41-51: Punctuation nit: Remove extra space before colon
In the headingSet the following environment variables :, drop the space before the colon for consistency with other docs (e.g.variables:).
132-133: Add missing article for readability
Consider adding “The” at the start of the description:- Supported transport types - Pipedream MCP server supports both SSE … + Supported transport types + The Pipedream MCP server supports both SSE …🧰 Tools
🪛 LanguageTool
[uncategorized] ~133-~133: You might be missing the article “the” here.
Context: ...llout> #### Supported transport types Pipedream MCP server supports both SSE and stream...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
⛔ Files ignored due to path filters (1)
pnpm-lock.yamlis excluded by!**/pnpm-lock.yaml
📒 Files selected for processing (3)
docs-v2/pages/connect/mcp/_meta.tsx(1 hunks)docs-v2/pages/connect/mcp/developers.mdx(7 hunks)docs-v2/pages/connect/mcp/openai.mdx(2 hunks)
🧰 Additional context used
🪛 LanguageTool
docs-v2/pages/connect/mcp/developers.mdx
[uncategorized] ~133-~133: You might be missing the article “the” here.
Context: ...llout> #### Supported transport types Pipedream MCP server supports both SSE and stream...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: pnpm publish
- GitHub Check: Lint Code Base
- GitHub Check: validate-links
🔇 Additional comments (13)
docs-v2/pages/connect/mcp/openai.mdx (1)
85-85: Update Node.js example to use remote MCP endpoint
Theserver_urlhas been correctly updated to point at the remote MCP server. Ensure the${externalUserId}and${appSlug}variables match the values you obtain above.docs-v2/pages/connect/mcp/_meta.tsx (1)
5-5: Simplified metadata key for OpenAI
Theopenaiproperty has been flattened from an object to a string"OpenAI", which streamlines the metadata configuration. Confirm that this change preserves the intended sidebar behavior.docs-v2/pages/connect/mcp/developers.mdx (11)
84-94: Explicit SDK initialization is clear and correct
The addition ofcreateBackendClientwithenvironment,credentials, andprojectIdoptions improves clarity for listing apps.
106-116: Consistent SDK initialization in search example
ThecreateBackendClientusage here matches the first tab, ensuring a uniform pattern for both listing and searching apps.
129-130: Informative beta callout is spot on
The new info callout clearly flags the server is in beta.
138-139: Base URL correctly updated
The example now points tohttps://remote.mcp.pipedream.net, matching the remote endpoint.
193-197: Self-hosting routes section updated
The two route definitions are concise and accurate.
200-205: Dockerfile instructions align with reference
Using the reference implementation GitHub link and commands is correct.
207-211: npx usage callout is clear
Thenpx @pipedream/mcp ssesnippet now explicitly highlights the SSE-only support.
213-215: HTTP support warning is helpful
The warning callout correctly informs users that HTTP support is coming soon.
219-224: Local dev command updates are correct
Switching topnpm installandpnpm dev:httpis consistent with the package manager preference.
235-241: Debugging section clarity
IncludingPD_SDK_DEBUG=truebeforepnpm dev:httpprovides a clear way to enable verbose logging.
251-257: Inspector URL example updated
The inspector URL for the remote server has been properly updated to use the new domain.
WHY
Summary by CodeRabbit