-
Notifications
You must be signed in to change notification settings - Fork 12
Update MCP quickstart based on docs team tests #314
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
base: main
Are you sure you want to change the base?
Conversation
✅ Deploy Preview for redpanda-connect ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the 📝 WalkthroughWalkthroughThe MCP server quickstart documentation is updated to reference Redpanda Connect 4.66.1 and to pivot examples from the example tag to bluesky. New sections add project initialization steps, version verification and upgrade instructions, detailed Bluesky tool configuration (YAML, discovery), start/run guidance using the bluesky tag, and expanded output examples. Additional instructions cover mcp-remote installation, Claude Code interaction prompts, and a new Troubleshooting section with JSON schema errors, port/connection notes, and tools exposure guidance. Separately, the Pipelines (streams mode) section in about.adoc is wrapped with ifndef::env-cloud[]/endif::[] to conditionally hide it in cloud builds. Sequence Diagram(s)sequenceDiagram
autonumber
actor User
participant Docs as Quickstart Guide
participant Shell as Terminal
participant MCP as MCP Server Project
participant RPC as Redpanda Connect
participant Claude as Claude Code
User->>Docs: Follow setup steps (init project, scaffold)
Docs-->>User: Version check & upgrade commands
User->>Shell: Verify RPC version (>= 4.66.1)
alt Version outdated
Shell-->>User: Shows older version
User->>Shell: Upgrade RPC
end
User->>MCP: Configure Bluesky tool (YAML, tags=bluesky)
User->>Shell: Start MCP with bluesky tag
MCP->>RPC: Connect and expose tools
note over MCP,RPC: Tool discovery and exposure
User->>Claude: Open Claude Code and select MCP tool
Claude->>MCP: Invoke Bluesky tool
MCP->>RPC: Execute tool action
RPC-->>MCP: Return result
MCP-->>Claude: Result
Claude-->>User: Display output
opt Troubleshooting
User->>Docs: Check Troubleshoot section
Docs-->>User: JSON schema, port, exposure guidance
end
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested reviewers
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
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. Comment |
└── example-processor.yaml | ||
---- | ||
|
||
. Make sure your Redpanda Connect version is at least 4.66.1: |
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.
. Make sure your Redpanda Connect version is at least 4.66.1: | |
. Check your Redpanda Connect version: |
Not sure if we need to mention the number again, as we already said so on pre-req
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.
Let's keep it and I'll remove the prereq
rpk connect --version | ||
---- | ||
+ | ||
If you need to upgrade, see xref:install:rpk.adoc#upgrade[Upgrade Redpanda Connect]. |
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.
We already have this line on pre-req. Suggestion is to remove either from pre-req or here. I vote to remove from pre-req.
Co-authored-by: Paulo Borges <[email protected]>
Co-authored-by: Paulo Borges <[email protected]>
Description
We recently did a session to test the quickstart. This PR implements the feedback we discussed as part of that process.
Page previews
Checks