Skip to content

Conversation

@dannyroosevelt
Copy link
Collaborator

@dannyroosevelt dannyroosevelt commented Jun 24, 2025

WHY

Summary by CodeRabbit

  • Documentation
    • Clarified which MCP server parameters can be passed via HTTP headers or query parameters.
    • Added four new optional HTTP headers to the documentation, with usage notes and links to additional resources.
    • Updated example JavaScript request code to demonstrate the use of the new headers.

@vercel
Copy link

vercel bot commented Jun 24, 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 Jun 24, 2025 0:17am
2 Skipped Deployments
Name Status Preview Comments Updated (UTC)
pipedream-docs ⬜️ Ignored (Inspect) Jun 24, 2025 0:17am
pipedream-docs-redirect-do-not-edit ⬜️ Ignored (Inspect) Jun 24, 2025 0:17am

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jun 24, 2025

Walkthrough

The documentation for MCP server integration was updated to clarify which parameters can be passed via headers or query parameters. Four new optional HTTP headers were added, each described and referenced with additional documentation. The example JavaScript code was also revised to demonstrate usage of one of the new headers.

Changes

File(s) Change Summary
docs-v2/pages/connect/mcp/developers.mdx Clarified parameter passing methods, added four new optional headers, updated example code.

Poem

In the warren of docs, new headers appear,
Four fresh carrots for devs to revere.
With OAuth and webhooks, the flow is precise,
Hop in with your headers, the code is concise.
🥕✨


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 (2)
docs-v2/pages/connect/mcp/developers.mdx (2)

317-321: Table formatting inconsistency

In the “Query Param” column you’ve inserted the literal text “Must be passed as header”.
That breaks the semantic intent of the column (which expects the actual query-param key).
Consider replacing with something neutral like / N/A, or add a dedicated “Header-only?” column.

-| `x-pd-oauth-app-id` | Must be passed as header | `oa_xxxxxxx` ...
+| `x-pd-oauth-app-id` | — | `oa_xxxxxxx` ...

Same for the other three new rows.


351-352: Minor example drift

Only x-pd-oauth-app-id is demonstrated in the sample request.
Since the preceding table introduces three additional header-only parameters (x-pd-webhook-uri, x-pd-error-redirect-uri, x-pd-success-redirect-uri), it may help readers if the snippet shows at least one of those as well, or adds a comment pointing to the table for the full list.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ee1dc02 and d27b8cc.

⛔ 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 (3 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: pnpm publish
  • GitHub Check: validate-links
  • GitHub Check: Lint Code Base
🔇 Additional comments (1)
docs-v2/pages/connect/mcp/developers.mdx (1)

305-306: Clarity improved – good call-out

Explicitly noting that “most” parameters work in both headers and query-strings removes a common source of confusion.

@dannyroosevelt dannyroosevelt merged commit a37360e into master Jun 24, 2025
9 checks passed
@dannyroosevelt dannyroosevelt deleted the danny/mcp-connect-token-opts-docs branch June 24, 2025 00:18
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