docs: DOC-1649 Redpanda Cloud MCP Server #369
Conversation
|
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 📝 WalkthroughWalkthroughAdded a new MCP-local AI Agents docs set (modules/ai-agents/pages/mcp/local: index.adoc, overview.adoc, quickstart.adoc, configuration.adoc) and two rpk-cloud pages (modules/reference/pages/rpk/rpk-cloud/rpk-cloud-mcp-install.adoc and rpk-cloud-mcp-stdio.adoc). Updated modules/ROOT/nav.adoc to insert an "rpk cloud mcp" subsection referencing the new rpk-cloud pages and relocated AI Agents navigation to ai-agents:mcp/local. Removed two legacy develop agents pages (modules/develop/pages/agents/about.adoc and create-support-agent.adoc). Added a new Antora content source entry in local-antora-playbook.yml. Sequence Diagram(s)(omitted — changes are documentation/navigation edits and do not modify runtime control flow) Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Assessment against linked issues
Out-of-scope changes
Possibly related PRs
Suggested reviewers
✨ Finishing Touches🧪 Generate unit tests
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 |
✅ Deploy Preview for rp-cloud ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
modules/reference/pages/rpk/rpk-cloud/rpk-cloud-mcp-install.adoc (1)
1-1: Prefer sentence-case titles for consistencyMost Redpanda CLI reference pages use sentence-case command titles (for example,
= rpk cloud login).
Consider updating to:= rpk cloud mcp installso the initial “rpk” is lowercase but each subsequent noun is lowercase as well, matching the established pattern.
modules/reference/pages/rpk/rpk-cloud/rpk-cloud-mcp-stdio.adoc (1)
1-1: Title style – align with existing CLI docsFor consistency with other rpk command docs, prefer sentence-case:
= rpk cloud mcp stdioMinor but keeps the rendered ToC coherent.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
modules/ROOT/nav.adoc(1 hunks)modules/reference/pages/rpk/rpk-cloud/rpk-cloud-mcp-install.adoc(1 hunks)modules/reference/pages/rpk/rpk-cloud/rpk-cloud-mcp-stdio.adoc(1 hunks)
🧰 Additional context used
🧠 Learnings (3)
📓 Common learnings
Learnt from: micheleRP
PR: redpanda-data/cloud-docs#267
File: modules/manage/pages/maintenance.adoc:91-92
Timestamp: 2025-04-25T01:41:57.162Z
Learning: The notification timeline for Redpanda Cloud deprecations has been deliberately removed from the documentation, even though the PR summary mentioned a 180-day advance notice period.
Learnt from: micheleRP
PR: redpanda-data/cloud-docs#278
File: modules/manage/pages/cluster-maintenance/config-cluster.adoc:75-75
Timestamp: 2025-04-29T18:43:42.666Z
Learning: In AsciiDoc documentation used by Redpanda, empty cross-references (xrefs) without link text (like `xref:manage:rpk/intro-to-rpk.adoc[]`) automatically use the target page's title as the link text.
modules/ROOT/nav.adoc (1)
Learnt from: micheleRP
PR: #334
File: modules/networking/partials/psc-api2.adoc:15-16
Timestamp: 2025-06-18T21:02:38.074Z
Learning: In the Redpanda Cloud documentation system, cross-reference anchors using the format #patch-/v1/clusters/-cluster.id- work correctly for referencing API endpoints, even with dashes instead of curly braces around parameter names.
modules/reference/pages/rpk/rpk-cloud/rpk-cloud-mcp-install.adoc (1)
Learnt from: micheleRP
PR: #278
File: modules/manage/pages/cluster-maintenance/config-cluster.adoc:75-75
Timestamp: 2025-04-29T18:43:42.666Z
Learning: In AsciiDoc documentation used by Redpanda, empty cross-references (xrefs) without link text (like xref:manage:rpk/intro-to-rpk.adoc[]) automatically use the target page's title as the link text.
🔇 Additional comments (2)
modules/reference/pages/rpk/rpk-cloud/rpk-cloud-mcp-install.adoc (1)
3-3: Verify the include target exists and the URI syntax is correct
include::ROOT:reference:partial$rpk-cloud/rpk-cloud-mcp-install.adoc[]is a less common Antora URI form (module family after:and$).
Double-check that:
- A partial file actually lives at
modules/reference/partials/rpk-cloud/rpk-cloud-mcp-install.adoc.- The family qualifier is correct (
partialis the family, not part of the path).
A more typical pattern is:include::reference:partial$rpk-cloud/rpk-cloud-mcp-install.adoc[tag=single-source]If the build fails to resolve the include, adjust accordingly.
modules/reference/pages/rpk/rpk-cloud/rpk-cloud-mcp-stdio.adoc (1)
3-3: Same include-path concern as in the install pageEnsure the partial exists and the Antora URI (
ROOT:reference:partial$...) resolves during the site build; otherwise switch to the standardreference:partial$…form.
JakeSCahill
changed the title
JakeSCahill
changed the title
|
@coderabbitai review |
✅ Actions performedReview triggered.
|
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
modules/ROOT/nav.adoc (1)
490-492: Root page for “rpk cloud mcp” (tracked earlier)Repeating the earlier suggestion to add a clickable root page or change the group to an xref for consistency with other
rpk cloudsub-sections. If the parent command isn’t published by design, feel free to ignore.Example:
-**** rpk cloud mcp +**** xref:reference:rpk/rpk-cloud/rpk-cloud-mcp.adoc[rpk cloud mcp]
🧹 Nitpick comments (8)
modules/ai-agents/pages/mcp/local/overview.adoc (3)
35-37: Clarify “install” vs “run” to avoid implying a daemon is started
rpk cloud mcp installconfigures the client; the server process is started on-demand viarpk cloud mcp stdio(or by the client), not by “install.” Recommend tightening wording.-. *Local MCP server*: Start the local MCP server using the xref:reference:rpk/rpk-cloud/rpk-cloud-mcp-install.adoc[`rpk cloud mcp install` command]. This process authenticates using the token obtained from `rpk cloud login` and runs the MCP server on your machine. +. **Local MCP server:** Configure your client using the xref:reference:rpk/rpk-cloud/rpk-cloud-mcp-install.adoc[`rpk cloud mcp install`] command. Your client then starts the server on‑demand via xref:reference:rpk/rpk-cloud/rpk-cloud-mcp-stdio.adoc[`rpk cloud mcp stdio`], authenticating with the token from `rpk cloud login`.
35-37: Consistency: use bold for all step labelsStep 1 uses bold, step 2 uses italics. Make both bold for consistency.
-. *Local MCP server*: +. **Local MCP server**:
52-52: Cross-ref target may be outside loaded components
xref:home:ROOT:mcp-setup.adoc[]depends on thehomecomponent containing this page. Please confirm the page exists and is included by the preview playbook.I can adjust the link or add the needed content source if it’s missing.
local-antora-playbook.yml (1)
19-21: Include “shared” in start_paths for docs-site in local preview
Addsharedalongsidehomeinstart_pathsso shared assets (e.g.,image::shared:includes) resolve during local Antora previews. Keep this change inlocal-antora-playbook.ymlonly; it will be reverted tomainbefore merge.- url: https://github.com/redpanda-data/docs-site branches: [main] - start_paths: [home] + start_paths: [home, shared]modules/ai-agents/pages/mcp/local/configuration.adoc (3)
55-68: Verify--allow-deletesupport on installEnsure
rpk cloud mcp install --client <...> --allow-deleteis supported (vs. needing to pass args to stdio). If not, provide the correct flag or a post-install edit step.I can adjust examples once the CLI behavior is confirmed.
113-114: Typo: duplicate “the”Small wording fix.
-To update, re-run the the xref:reference:rpk/rpk-cloud/rpk-cloud-mcp-install.adoc[`rpk cloud mcp install` command]. +To update, re-run the xref:reference:rpk/rpk-cloud/rpk-cloud-mcp-install.adoc[`rpk cloud mcp install` command].
148-154: Typo and clarity when starting manuallyFix duplicate “the” and explicitly note the session is ephemeral.
-. [[local]]Start the server manually using the the xref:reference:rpk/rpk-cloud/rpk-cloud-mcp-stdio.adoc[`rpk cloud mcp stdio` command] (one-time login required) to make sure it can reach Redpanda Cloud endpoints: +. [[local]]Start the server manually using the xref:reference:rpk/rpk-cloud/rpk-cloud-mcp-stdio.adoc[`rpk cloud mcp stdio` command] (one-time login required) to verify connectivity to Redpanda Cloud endpoints:modules/ai-agents/pages/mcp/local/quickstart.adoc (1)
62-63: Cross-link to deletes section for discoverabilityConsider linking to the configuration page’s “Enable delete operations” section to guide users who opt in.
-NOTE: The MCP server does **not** expose API endpoints that result in delete operations by default. Use `--allow-delete` only if you intentionally want to enable the delete operations. +NOTE: The MCP server does **not** expose API endpoints that result in delete operations by default. Use `--allow-delete` only if you intentionally want to enable delete operations. See xref:ai-agents:mcp/local/configuration.adoc#_enable_delete_operations[Enable delete operations].
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
⛔ Files ignored due to path filters (1)
modules/shared/images/cloud-mcp.gifis excluded by!**/*.gif
📒 Files selected for processing (8)
local-antora-playbook.yml(1 hunks)modules/ROOT/nav.adoc(2 hunks)modules/ai-agents/pages/mcp/local/configuration.adoc(1 hunks)modules/ai-agents/pages/mcp/local/index.adoc(1 hunks)modules/ai-agents/pages/mcp/local/overview.adoc(1 hunks)modules/ai-agents/pages/mcp/local/quickstart.adoc(1 hunks)modules/develop/pages/agents/about.adoc(0 hunks)modules/develop/pages/agents/create-support-agent.adoc(0 hunks)
💤 Files with no reviewable changes (2)
- modules/develop/pages/agents/create-support-agent.adoc
- modules/develop/pages/agents/about.adoc
✅ Files skipped from review due to trivial changes (1)
- modules/ai-agents/pages/mcp/local/index.adoc
🧰 Additional context used
🧠 Learnings (2)
📚 Learning: 2025-08-15T04:45:28.695Z
Learnt from: micheleRP
PR: redpanda-data/cloud-docs#390
File: modules/manage/pages/schema-reg/schema-reg-authorization.adoc:4-4
Timestamp: 2025-08-15T04:45:28.695Z
Learning: In the Redpanda documentation system, content is single-sourced across multiple repositories (cloud-docs and docs repos). Include directives in the cloud-docs repo may reference files that exist in separate PRs in the docs repo. These PRs are linked via local-antora-playbook.yml for preview rendering, and the includes resolve correctly during the Antora build process when repositories are merged. The playbook is reverted to main before merging. This cross-repository single sourcing pattern is commonly used, so missing include targets should be verified against linked PRs in other repositories before flagging as errors.
Applied to files:
local-antora-playbook.yml
📚 Learning: 2025-08-15T02:29:34.901Z
Learnt from: micheleRP
PR: redpanda-data/cloud-docs#390
File: modules/manage/pages/schema-reg/schema-reg-authorization.adoc:4-4
Timestamp: 2025-08-15T02:29:34.901Z
Learning: In Redpanda Cloud documentation PRs, when CodeRabbit flags missing Asciidoctor tag markers for include directives, the fix may be implemented in the corresponding ROOT module file that contains the actual content being included, rather than in the file where the include directive appears.
Applied to files:
modules/ROOT/nav.adoc
🔇 Additional comments (6)
modules/ai-agents/pages/mcp/local/overview.adoc (1)
13-13: Verify image source component (“shared”) is included in playbook
image::shared:cloud-mcp.gif[]relies on asharedcomponent. Ensure the preview playbook includes that component, or the image will 404 in previews.Would you like me to add
sharedtostart_pathsinlocal-antora-playbook.yml?modules/ROOT/nav.adoc (1)
72-75: Nice: clear, discoverable MCP Local sectionNew AI Agents/MCP Local group with index/overview/quickstart/configure reads well and matches the reorg.
modules/ai-agents/pages/mcp/local/configuration.adoc (2)
46-46: Link target accuracy: default config pathsThe “default paths” are referenced in
rpk cloud logindocs. Please verify those paths are indeed documented there; otherwise link to the page that enumerates them.
160-163: Protocol version string: confirm correctness
"protocolVersion":"2025-06-18"looks like a date. Please confirm this is the MCP protocol identifier expected by clients; otherwise switch to the current supported value or omit.modules/ai-agents/pages/mcp/local/quickstart.adoc (2)
37-38: Good security calloutClear statement that the token is local and not shared with the assistant.
15-19: Clarify rpk & MCP context for version requirement
Provide the specific rpk binary and a link to this MCP quickstart so we can determine the earliest version supporting install/stdio and align the “minimum version” (e.g. “25.1.2+ (25.2.3+ recommended)”) accordingly.
asimms41
left a comment
asimms41
left a comment
There was a problem hiding this comment.
Just a couple of small suggestions. No blockers.
Co-authored-by: Angela Simms <[email protected]>
Description
Do not merge until Redpanda v25.2.3 is released
Related source redpanda-data/docs#1242
Resolves https://github.com/redpanda-data/documentation-private/issues/DOC-1301
Resolves https://github.com/redpanda-data/documentation-private/issues/DOC-1649
This pull request introduces new documentation for the Redpanda Cloud MCP (Model Context Protocol) Server and reorganizes the AI Agents section to focus on this new feature. It adds comprehensive guides for setup, configuration, and usage of the MCP server with AI assistants like Claude and Claude Code. The navigation is updated to reflect these changes, and legacy support agent documentation is removed.
AI Agents & MCP Server Documentation Overhaul:
Navigation and Structure Updates:
nav.adocto replace the old AI Agents links with the new MCP Server documentation, and added new references forrpk cloud mcpcommands under the CLI reference. [1] [2]docs-siterepo and itshomestart path, supporting the new documentation structure.Reference Documentation for CLI Integration:
rpk cloud mcp installandrpk cloud mcp stdiocommands, supporting the setup and troubleshooting instructions in the MCP docs. [1] [2]Page previews
https://deploy-preview-369--rp-cloud.netlify.app/redpanda-cloud/ai-agents/mcp/local/
Checks