Skip to content

Commit 0630114

Browse files
authored
Add new MCP rpk docs (#1358)
1 parent a676d91 commit 0630114

File tree

4 files changed

+150
-10
lines changed

4 files changed

+150
-10
lines changed
Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
= rpk cloud mcp install
2-
// tag::single-source[]
3-
4-
Install Redpanda Cloud MCP server.
2+
:description: Install the local MCP server for Redpanda Cloud configuration.
53

6-
Only Claude Desktop is supported at this time.
4+
// tag::single-source[]
5+
Install the MCP client configuration to connect your AI assistant to the local MCP server for Redpanda Cloud.
76

8-
Writes an mcpServer entry with name "redpandaCloud" into `claude_desktop_config.json` in Claude Desktop's config directory.
7+
This command generates and installs the necessary configuration files for your MCP client (like Claude Code) to automatically connect to the local MCP server for Redpanda Cloud. The local MCP server provides your AI assistant with tools to manage your Redpanda Cloud account and clusters.
98

109
== Usage
1110

@@ -14,15 +13,24 @@ Writes an mcpServer entry with name "redpandaCloud" into `claude_desktop_config.
1413
rpk cloud mcp install [flags]
1514
----
1615

16+
== Examples
17+
18+
Install configuration for Claude Code:
19+
20+
[,bash]
21+
----
22+
rpk cloud mcp install --client claude-code
23+
----
24+
1725
== Flags
1826

1927
[cols="1m,1a,2a"]
2028
|===
2129
|*Value* |*Type* |*Description*
2230

23-
|--allow-delete |- |Allows the deletion of RPCs.
31+
|--allow-delete |- |Allow delete operations (RPCs). Off by default.
2432

25-
|--client |string |Name of the MCP client to configure (default "claude").
33+
|--client |string |Name of the MCP client to configure. Supported values: `claude` or `claude-code`.
2634

2735
|-h, --help |- |Help for install.
2836

@@ -35,4 +43,9 @@ rpk cloud mcp install [flags]
3543
|-v, --verbose |- |Enable verbose logging.
3644
|===
3745

46+
== Suggested reading
47+
48+
* xref:ai-agents:mcp/local/quickstart.adoc[]
49+
* xref:reference:rpk/rpk-cloud/rpk-cloud-mcp-stdio.adoc[]
50+
3851
// end::single-source[]
Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
= rpk cloud mcp proxy
2+
:description: Proxy MCP requests to Remote MCP servers in Redpanda Cloud
3+
4+
// tag::single-source[]
5+
6+
*Introduced in version 25.2.3*.
7+
8+
Proxy MCP requests from your local AI client to a remote MCP server running in your Redpanda Cloud cluster.
9+
10+
This command acts as a bridge between your AI assistant (like Claude) and your remote MCP server. It handles connection management, and request proxying so your AI client can use tools hosted in your cluster.
11+
12+
== Modes of operation
13+
14+
*Install mode* (recommended): Generates and installs MCP client configuration files that tell your AI client how to connect. This is a one-time setup operation.
15+
16+
*Proxy mode* (default): Serves stdio and proxies requests in real-time. Your AI client connects to this command's stdio interface, and requests are forwarded to the remote MCP server.
17+
18+
== Usage
19+
20+
[,bash]
21+
----
22+
rpk cloud mcp proxy [flags]
23+
----
24+
25+
== Examples
26+
27+
Proxy requests to a specific MCP server:
28+
29+
[,bash]
30+
----
31+
rpk cloud mcp proxy --cluster-id <cluster-id> --mcp-server-id <server-id>
32+
----
33+
34+
Install Claude Code configuration for connecting to your MCP server in Redpanda Cloud BYOC or Dedicated:
35+
36+
[,bash]
37+
----
38+
rpk cloud mcp proxy --install --client claude-code --cluster-id <cluster-id> --mcp-server-id <server-id>
39+
----
40+
41+
Install Claude Code configuration for connecting to your MCP server in Redpanda Cloud Serverless:
42+
43+
[,bash]
44+
----
45+
rpk cloud mcp proxy --install --client claude-code --serverless-cluster-id <cluster-id> --mcp-server-id <server-id>
46+
----
47+
48+
== Flags
49+
50+
[cols="1m,1a,2a"]
51+
|===
52+
|*Value* |*Type* |*Description*
53+
54+
|--client |string |Name of the MCP client to configure. Required when using `--install`. Supported values: `claude` and `claude-code`.
55+
56+
|--cluster-id |string |Cluster ID where your Remote MCP server is running. Find this in the Redpanda Cloud Console.
57+
58+
|--serverless-cluster-id |string |Serverless cluster ID where your Remote MCP server is running. Find this in the Redpanda Cloud Console.
59+
60+
|-h, --help |- |Help for proxy.
61+
62+
|--install |- |Install MCP client configuration instead of serving stdio. Use this for one-time setup.
63+
64+
|--mcp-server-id |string |ID of the Remote MCP server to connect to. Find this in your cluster's Remote MCP page.
65+
66+
|--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`.
67+
68+
|-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.
69+
70+
|--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details.
71+
72+
|-v, --verbose |- |Enable verbose logging.
73+
|===
74+
75+
== See also
76+
77+
* xref:ai-agents:mcp/remote/quickstart.adoc[]
78+
* xref:reference:rpk/rpk-cloud/rpk-cloud-mcp-install.adoc[]
79+
80+
// end::single-source[]

modules/reference/partials/rpk-cloud/rpk-cloud-mcp-stdio.adoc

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,12 @@
11
= rpk cloud mcp stdio
2+
:description: Communicate with local MCP server for Redpanda Cloud using the stdio protocol.
23
// tag::single-source[]
34

4-
MCP `stdio` server. Can be used by MCP clients.
5+
Communicate with the local MCP server for Redpanda Cloud using the stdio protocol.
6+
7+
This command provides a direct stdio interface for communicating with the local MCP server for Redpanda Cloud. The local MCP server runs on your machine and provides tools for managing your Redpanda Cloud account and clusters. It's typically used as the transport mechanism when your MCP client is configured to use `rpk` as the stdio server process.
8+
9+
Most users should use xref:reference:rpk/rpk-cloud/rpk-cloud-mcp-install.adoc[`rpk cloud mcp install`] instead, which automatically configures your MCP client.
510

611
== Usage
712

@@ -10,13 +15,22 @@ MCP `stdio` server. Can be used by MCP clients.
1015
rpk cloud mcp stdio [flags]
1116
----
1217

18+
== Examples
19+
20+
Start the local MCP server for Redpanda Cloud using the stdio protocol:
21+
22+
[,bash]
23+
----
24+
rpk cloud mcp stdio
25+
----
26+
1327
== Flags
1428

1529
[cols="1m,1a,2a"]
1630
|===
1731
|*Value* |*Type* |*Description*
1832

19-
|--allow-delete |- |Allows the deletion of RPCs. Off by default.
33+
|--allow-delete |- |Allow delete operations (RPCs). Off by default.
2034

2135
|-h, --help |- |Help for stdio.
2236

@@ -29,4 +43,9 @@ rpk cloud mcp stdio [flags]
2943
|-v, --verbose |- |Enable verbose logging.
3044
|===
3145

46+
== Suggested reading
47+
48+
* xref:reference:rpk/rpk-cloud/rpk-cloud-mcp-install.adoc[]
49+
* xref:ai-agents:mcp/local/overview.adoc[]
50+
3251
// end::single-source[]

modules/reference/partials/rpk-cloud/rpk-cloud-mcp.adoc

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,35 @@
11
= rpk cloud mcp
2+
:description: Manage connections to MCP servers in Redpanda Cloud.
23
// tag::single-source[]
34

5+
Manage connections to MCP servers in Redpanda Cloud. This includes both the local MCP server for Redpanda Cloud and remote MCP servers (managed).
6+
7+
These commands help you connect AI assistants like Claude to different types of MCP servers:
8+
9+
* **Local MCP server for Redpanda Cloud**: Runs on your local machine and provides access to your Redpanda Cloud account and clusters
10+
* **Remote MCP servers**: Custom servers you build and deploy that run inside your Redpanda Cloud clusters
11+
412
== Usage
513

614
[,bash]
715
----
8-
rpk cloud mcp [command] [flags]
16+
rpk cloud mcp [flags]
17+
rpk cloud mcp [command]
918
----
1019

20+
== Subcommands
21+
22+
[cols="1m,2a"]
23+
|===
24+
|Command |Description
25+
26+
|xref:reference:rpk/rpk-cloud/rpk-cloud-mcp-install.adoc[install] |Install the local MCP server for Redpanda Cloud configuration.
27+
28+
|xref:reference:rpk/rpk-cloud/rpk-cloud-mcp-proxy.adoc[proxy] |Proxy requests to Remote MCP servers.
29+
30+
|xref:reference:rpk/rpk-cloud/rpk-cloud-mcp-stdio.adoc[stdio] |Communicate with the local MCP server for Redpanda Cloud using the stdio protocol.
31+
|===
32+
1133
== Flags
1234

1335
[cols="1m,1a,2a"]
@@ -25,4 +47,10 @@ rpk cloud mcp [command] [flags]
2547
|-v, --verbose |- |Enable verbose logging.
2648
|===
2749

50+
== Suggested reading
51+
52+
* xref:ai-agents:mcp/local/quickstart.adoc[]
53+
* xref:ai-agents:mcp/remote/quickstart.adoc[]
54+
* xref:ai-agents:mcp/overview.adoc[]
55+
2856
// end::single-source[]

0 commit comments

Comments
 (0)