Skip to content

Conversation

@dannyroosevelt
Copy link
Collaborator

@dannyroosevelt dannyroosevelt commented May 21, 2025

WHY

Summary by CodeRabbit

  • Documentation
    • Clarified environment variable setup and added a link to additional environment info.
    • Improved code examples for listing and searching MCP apps, including explicit backend client initialization.
    • Updated MCP server URLs in documentation and examples to use the new remote server address.
    • Noted beta status of the remote MCP server and clarified supported transport types.
    • Enhanced self-hosting and Docker instructions for better clarity and usability.
    • Consolidated and reordered instructions for starting and debugging the server.
    • Updated MCP inspector URL example to reflect the new server URL.

@vercel
Copy link

vercel bot commented May 21, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs-v2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 21, 2025 6:36pm
2 Skipped Deployments
Name Status Preview Comments Updated (UTC)
pipedream-docs ⬜️ Ignored (Inspect) May 21, 2025 6:36pm
pipedream-docs-redirect-do-not-edit ⬜️ Ignored (Inspect) May 21, 2025 6:36pm

@coderabbitai
Copy link
Contributor

coderabbitai bot commented May 21, 2025

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 @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

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.

📥 Commits

Reviewing files that changed from the base of the PR and between fc0d67b and 51ee7bd.

⛔ Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
📒 Files selected for processing (1)
  • docs-v2/pages/connect/mcp/developers.mdx (6 hunks)

Walkthrough

The 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

File(s) Change Summary
docs-v2/pages/connect/mcp/_meta.tsx Simplified the openai property in the exported default object from an object with title and display to a direct string value "OpenAI".
docs-v2/pages/connect/mcp/developers.mdx Updated documentation for environment variable setup, clarified and improved code examples, changed MCP server URLs to the new remote endpoint, added beta notice, improved self-hosting instructions, reworded Dockerfile steps, consolidated server start methods, and updated debugging instructions. No changes to exported/public entities.
docs-v2/pages/connect/mcp/openai.mdx Updated the MCP server URL in Node.js and cURL examples from https://mcp.pipedream.net to https://remote.mcp.pipedream.net. No other changes to request structure or authentication.

Poem

In the warren where docs are spun,
New URLs hop—remote, not just one!
OpenAI’s name, now simply strung,
Instructions polished, code examples sung.
With every update, the carrots grow tall,
Rabbits rejoice in clear docs for all! 🥕✨


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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need 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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a 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_SLUG inside 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 heading Set 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

📥 Commits

Reviewing files that changed from the base of the PR and between cd3067c and fc0d67b.

⛔ Files ignored due to path filters (1)
  • pnpm-lock.yaml is 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
The server_url has 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
The openai property 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 of createBackendClient with environment, credentials, and projectId options improves clarity for listing apps.


106-116: Consistent SDK initialization in search example
The createBackendClient usage 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 to https://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
The npx @pipedream/mcp sse snippet 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 to pnpm install and pnpm dev:http is consistent with the package manager preference.


235-241: Debugging section clarity
Including PD_SDK_DEBUG=true before pnpm dev:http provides 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.

@dannyroosevelt dannyroosevelt merged commit 670ec7b into master May 21, 2025
9 checks passed
@dannyroosevelt dannyroosevelt deleted the danny/mcp-dev-docs-rev branch May 21, 2025 18:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants