Skip to content

Conversation

JakeSCahill
Copy link
Contributor

@JakeSCahill JakeSCahill commented Oct 8, 2025

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

  • New feature
  • Content gap
  • Support Follow-up
  • Small fix (typos, links, copyedits, etc)

@JakeSCahill JakeSCahill requested a review from a team as a code owner October 8, 2025 15:44
Copy link

netlify bot commented Oct 8, 2025

Deploy Preview for redpanda-connect ready!

Name Link
🔨 Latest commit fbb7855
🔍 Latest deploy log https://app.netlify.com/projects/redpanda-connect/deploys/68e7be514e475000089c8630
😎 Deploy Preview https://deploy-preview-314--redpanda-connect.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link
Contributor

coderabbitai bot commented Oct 8, 2025

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

📝 Walkthrough

Walkthrough

The 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
Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Suggested reviewers

  • Jeffail
  • kbatuigas

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Title Check ✅ Passed The title clearly states that the MCP quickstart is being updated based on the docs team’s testing feedback, which directly reflects the main changes made to the quickstart content. It is concise, specific, and free of extraneous details, making it easy for reviewers to grasp the primary purpose at a glance.
Description Check ✅ Passed The description explains that the PR implements feedback from a recent quickstart testing session and identifies the context of updating the quickstart, which aligns with the detailed changes to the MCP quickstart content. It clearly relates to the changeset despite not enumerating every edit, satisfying the lenient relevance requirement.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.

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

Comment @coderabbitai help to get the list of available commands and usage tips.

└── example-processor.yaml
----

. Make sure your Redpanda Connect version is at least 4.66.1:

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
. 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

Copy link
Contributor Author

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].

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.

@paulohtb6 paulohtb6 mentioned this pull request Oct 8, 2025
4 tasks
@JakeSCahill JakeSCahill requested a review from paulohtb6 October 9, 2025 13:53
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