docs: create entry for rpk mcp reference #1242
Conversation
✅ Deploy Preview for redpanda-docs-preview 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 📝 WalkthroughWalkthroughTwo new documentation partials have been added for the Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes 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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed 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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (6)
modules/reference/partials/rpk-cloud/rpk-cloud-mcp-install.adoc (3)
12-15: Use the canonical[source,bash]block attributeThe language‐specifying attribute is missing the
sourcequalifier, which prevents syntax highlighting in most Asciidoctor renderers.-[,bash] +[source,bash]
23-35: Standardise the Type column for boolean flagsThe table currently uses
-for boolean values while string and array types are fully spelled out. Replace-withboolto keep the column semantically meaningful and in line with other docs.-|--allow-delete |- |Allow delete RPCs. -|-h, --help |- |Help for install. -|-v, --verbose |- |Enable verbose logging. +|--allow-delete |bool |Allow delete RPCs. +|-h, --help |bool |Help for install. +|-v, --verbose |bool |Enable verbose logging.
8-8: Back-tick themcpServerfield for readabilityMarking field names as code improves legibility and matches the style used elsewhere in the file.
-Writes an mcpServer entry with name "redpandaCloud" into `claude_desktop_config.json` in Claude Desktop's config directory. +Writes an `mcpServer` entry named `"redpandaCloud"` into `claude_desktop_config.json` in Claude Desktop's config directory.modules/reference/partials/rpk-cloud/rpk-cloud-mcp-stdio.adoc (3)
7-10: Addsourcequalifier to enable syntax highlightingMirror the change suggested for the install page.
-[,bash] +[source,bash]
18-28: Align boolean flag types with the rest of the docsFor consistency, label boolean flags explicitly as
bool.-|--allow-delete |- |Allow delete RPCs. Off by default. -|-h, --help |- |Help for stdio. -|-v, --verbose |- |Enable verbose logging. +|--allow-delete |bool |Allow delete RPCs. Off by default. +|-h, --help |bool |Help for stdio. +|-v, --verbose |bool |Enable verbose logging.
1-29: Consider extracting a shared partial for the common flag tableBoth MCP pages repeat the same flag definitions. A shared partial (for example,
_partials/rpk-cloud/common-mcp-flags.adoc) would reduce duplication and the risk of future drift.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
modules/reference/partials/rpk-cloud/rpk-cloud-mcp-install.adoc(1 hunks)modules/reference/partials/rpk-cloud/rpk-cloud-mcp-stdio.adoc(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: Redirect rules - redpanda-docs-preview
- GitHub Check: Header rules - redpanda-docs-preview
- GitHub Check: Pages changed - redpanda-docs-preview
|
hey @r-vasquez does the |
modules/reference/partials/rpk-cloud/rpk-cloud-mcp-install.adoc
Outdated
Show resolved
Hide resolved
|
Hi @paulohtb6, LGTM, but I'm also tagging the expert on this command @birdayz in case you have something else to add here. 👍 w.r.t the parent command being empty, I fixed this in redpanda-data/redpanda@346a04a, but it does nothing, is just the parent command. <- This will be out for 25.2 |
Co-authored-by: Joyce Fee <[email protected]>
Description
Cloud reference redpanda-data/cloud-docs#369
Resolves https://redpandadata.atlassian.net/browse/DOC-1301
Review deadline:
Page previews
Checks