Skip to content

Commit ea7aeac

Browse files
paulohtb6Feediver1
andauthored
docs: create entry for rpk mcp reference (#1242)
Co-authored-by: Joyce Fee <102751339+Feediver1@users.noreply.github.com>
1 parent 3bdb87e commit ea7aeac

3 files changed

Lines changed: 98 additions & 0 deletions

File tree

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
= rpk cloud mcp install
2+
// tag::single-source[]
3+
4+
Install Redpanda Cloud MCP server.
5+
6+
Only Claude Desktop is supported at this time.
7+
8+
Writes an mcpServer entry with name "redpandaCloud" into `claude_desktop_config.json` in Claude Desktop's config directory.
9+
10+
== Usage
11+
12+
[,bash]
13+
----
14+
rpk cloud mcp install [flags]
15+
----
16+
17+
== Flags
18+
19+
[cols="1m,1a,2a"]
20+
|===
21+
|*Value* |*Type* |*Description*
22+
23+
|--allow-delete |- |Allows the deletion of RPCs.
24+
25+
|--client |string |Name of the MCP client to configure (default "claude").
26+
27+
|-h, --help |- |Help for install.
28+
29+
|--config |string |Redpanda or `rpk` config file; default search paths are `/var/lib/redpanda/.config/rpk/rpk.yaml`, `$PWD/redpanda.yaml`, and `/etc/redpanda/redpanda.yaml`.
30+
31+
|-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail.
32+
33+
|--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details.
34+
35+
|-v, --verbose |- |Enable verbose logging.
36+
|===
37+
38+
// end::single-source[]
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
= rpk cloud mcp stdio
2+
// tag::single-source[]
3+
4+
MCP `stdio` server. Can be used by MCP clients.
5+
6+
== Usage
7+
8+
[,bash]
9+
----
10+
rpk cloud mcp stdio [flags]
11+
----
12+
13+
== Flags
14+
15+
[cols="1m,1a,2a"]
16+
|===
17+
|*Value* |*Type* |*Description*
18+
19+
|--allow-delete |- |Allows the deletion of RPCs. Off by default.
20+
21+
|-h, --help |- |Help for stdio.
22+
23+
|--config |string |Redpanda or `rpk` config file; default search paths are `/var/lib/redpanda/.config/rpk/rpk.yaml`, `$PWD/redpanda.yaml`, and `/etc/redpanda/redpanda.yaml`.
24+
25+
|-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail.
26+
27+
|--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details.
28+
29+
|-v, --verbose |- |Enable verbose logging.
30+
|===
31+
32+
// end::single-source[]
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
= rpk cloud mcp
2+
// tag::single-source[]
3+
4+
== Usage
5+
6+
[,bash]
7+
----
8+
rpk cloud mcp [command] [flags]
9+
----
10+
11+
== Flags
12+
13+
[cols="1m,1a,2a"]
14+
|===
15+
|*Value* |*Type* |*Description*
16+
17+
|-h, --help |- |Help for mcp.
18+
19+
|--config |string |Redpanda or `rpk` config file; default search paths are `/var/lib/redpanda/.config/rpk/rpk.yaml`, `$PWD/redpanda.yaml`, and `/etc/redpanda/redpanda.yaml`.
20+
21+
|-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail.
22+
23+
|--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details.
24+
25+
|-v, --verbose |- |Enable verbose logging.
26+
|===
27+
28+
// end::single-source[]

0 commit comments

Comments
 (0)