Skip to content

Commit 1e15afc

Browse files
JakeSCahillclaude
andauthored
Improve MCP documentation compliance with Redpanda docs standards (#486)
* Update nav entry for MCP Server for the Redpanda Cloud API * Improve MCP documentation compliance with style standards - Add missing learning objectives displays to local overview, quickstart, and configuration pages - Add intro text following "After [prerequisite], [action]" pattern - Remove periods from prerequisite fragments per style guide - Fix passive voice in remote admin pages (admin-guide, manage-servers, monitor-activity, scale-resources) - Remove redundant Data Plane API section from admin-guide (content belongs in child pages) - Convert loose paragraph to TIP in configuration page Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> * Update local-antora-playbook.yml * Update index.adoc * Rename "MCP Server for the Redpanda Cloud API" to "Redpanda Cloud API MCP" Updated terminology throughout documentation for consistency and brevity. Changes: - Navigation entries - Page titles and descriptions - Content references - Cross-reference link text Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> * Redpanda Cloud Management MCP Server * Fix MCP overview title and learning objectives - Update title to "MCP Servers for Redpanda Cloud Overview" - Update learning objective 2 to explicitly distinguish between "Redpanda Cloud Management MCP Server" and "Remote MCP" Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> * Update terminology to Redpanda Cloud Management MCP Server in release notes - Replace "Redpanda Cloud MCP Server" with "Redpanda Cloud Management MCP Server" - Change "This local server" to "This server runs on your computer" for clarity Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> * Address PR review feedback Based on feedback from PR #486: local/overview.adoc: - Shorten introduction and move learning objectives before image - Add intro sentence to Components section - Convert "Suggested reading" section to TIP - Remove "Continue your learning journey" intro text from Next steps local/quickstart.adoc: - Remove "Continue your learning journey" intro text from Next steps local/configuration.adoc: - Simplify terminology: "supports the Model Context Protocol" → "supports MCP" remote/overview.adoc: - Remove "Continue your learning journey" intro text from Next steps remote/concepts.adoc: - Remove "Continue your learning journey" intro text from Next steps remote/monitor-activity.adoc: - Fix broken Data Plane API link Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> --------- Co-authored-by: Claude Sonnet 4.5 <noreply@anthropic.com>
1 parent 0935dbb commit 1e15afc

17 files changed

Lines changed: 125 additions & 130 deletions

local-antora-playbook.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ asciidoc:
3838
- '@redpanda-data/docs-extensions-and-macros/macros/rp-connect-components'
3939
- '@redpanda-data/docs-extensions-and-macros/macros/glossary'
4040
- '@redpanda-data/docs-extensions-and-macros/macros/config-ref'
41+
- '@redpanda-data/docs-extensions-and-macros/macros/badge'
4142
- '@redpanda-data/docs-extensions-and-macros/macros/helm-ref'
4243
- '@redpanda-data/docs-extensions-and-macros/asciidoc-extensions/add-line-numbers-highlights'
4344
antora:

modules/ROOT/nav.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@
7171
7272
* xref:ai-agents:index.adoc[AI Agents]
7373
** xref:ai-agents:mcp/overview.adoc[MCP Overview]
74-
** xref:ai-agents:mcp/local/index.adoc[Local Redpanda Cloud MCP]
74+
** xref:ai-agents:mcp/local/index.adoc[Redpanda Cloud Management MCP Server]
7575
*** xref:ai-agents:mcp/local/overview.adoc[Overview]
7676
*** xref:ai-agents:mcp/local/quickstart.adoc[Quickstart]
7777
*** xref:ai-agents:mcp/local/configuration.adoc[Configure]

modules/ai-agents/pages/index.adoc

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,4 @@
55

66
AI agents are configurable assistants that autonomously perform specialist tasks by leveraging large language models (LLMs) and connecting to external data sources and tools.
77

8-
Redpanda Cloud provides two complementary Model Context Protocol (MCP) options to help you build AI agents:
9-
10-
MCP server for the Redpanda Cloud API badge::[label=beta, tooltip={page-beta-text}]::
11-
A built-in server that gives your AI agent direct access to your Redpanda Cloud account and clusters. This runs locally on your computer and lets you quickly perform operations like creating clusters, listing topics, and reading messages.
12-
13-
Remote MCP::
14-
Your own custom MCP servers built with Redpanda Connect pipelines and hosted inside your Redpanda Cloud cluster. These let you create reusable tools for your team that integrate with knowledge bases, APIs, and web content while running close to your data.
8+
Redpanda Cloud provides two complementary Model Context Protocol (MCP) options to help you build AI agents.

modules/ai-agents/pages/mcp/local/configuration.adoc

Lines changed: 41 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,52 @@
1-
= Configure the MCP Server for the Redpanda Cloud API
1+
= Configure the Redpanda Cloud Management MCP Server
22
:page-beta: true
3-
:description: Learn how to configure the MCP server for the Redpanda Cloud API, including auto and manual client setup, enabling deletes, and security considerations.
3+
:description: Learn how to configure the Redpanda Cloud Management MCP Server, including auto and manual client setup, enabling deletes, and security considerations.
44
:page-topic-type: how-to
55
:personas: ai_agent_developer, platform_admin
66
// Reader journey: "I customize and configure"
77
// Learning objectives - what readers can learn from this page:
8-
:learning-objective-1: Configure MCP clients manually
8+
:learning-objective-1: Configure MCP clients
99
:learning-objective-2: Enable delete operations safely
1010
:learning-objective-3: Troubleshoot common configuration issues
1111

12-
This page explains how to configure the MCP server for the Redpanda Cloud API, including auto and manual client setup, enabling deletes, and security considerations.
12+
After installing the Redpanda Cloud Management MCP Server, you can configure it for different AI clients, customize security settings, and troubleshoot common issues.
1313

14-
== Prerequisites
14+
After reading this page, you will be able to:
1515

16-
* At least version 25.2.3 of xref:manage:rpk/rpk-install.adoc[`rpk` installed on your computer].
17-
* Access to a Redpanda Cloud account.
18-
* Supported AI client (Claude, Claude Code, or other MCP-compatible client).
16+
* [ ] {learning-objective-1}
17+
* [ ] {learning-objective-2}
18+
* [ ] {learning-objective-3}
1919
20-
== Endpoint availability
20+
== Prerequisites
2121

22-
The MCP server exposes Redpanda Cloud API endpoints for both the link:https://docs.redpanda.com/api/doc/cloud-controlplane/[Control Plane] and the link:https://docs.redpanda.com/api/doc/cloud-dataplane/[Data Plane] through `rpk`. Available endpoints depend on your `rpk` version. Newer API features require updated versions of `rpk`.
22+
* At least version 25.2.3 of xref:manage:rpk/rpk-install.adoc[`rpk` installed on your local machine]
23+
* Access to a Redpanda Cloud account
24+
* An MCP-compatible AI client such as Claude, Claude Code, or another tool that supports MCP
2325

24-
TIP: Keep `rpk` updated to the latest version to access new Redpanda Cloud features through the MCP server. New MCP endpoints are documented in Redpanda link:https://github.com/redpanda-data/redpanda/releases[release notes].
26+
TIP: The MCP server exposes Redpanda Cloud API endpoints for both the link:https://docs.redpanda.com/api/doc/cloud-controlplane/[Control Plane] and the link:https://docs.redpanda.com/api/doc/cloud-dataplane/[Data Plane]. Available endpoints depend on your `rpk` version. Keep `rpk` updated to access new Redpanda Cloud features through the MCP server. New MCP endpoints are documented in Redpanda link:https://github.com/redpanda-data/redpanda/releases[release notes].
2527

26-
== Auto-configured clients (Claude and Claude Code)
28+
== Install the integration for Claude or Claude Code
2729

2830
For some supported clients, you can install and configure the MCP integration using the xref:reference:rpk/rpk-cloud/rpk-cloud-mcp-install.adoc[`rpk cloud mcp install` command].
2931
For Claude and Claude Code, run one of these commands:
3032

31-
```bash
33+
[source,bash]
34+
----
3235
# Choose one
3336
rpk cloud mcp install --client claude
3437
rpk cloud mcp install --client claude-code
35-
```
38+
----
3639

3740
If you need to update the integration, re-run the install command for your client.
3841

39-
== Manual configuration for other MCP clients
42+
== Configure other MCP clients manually
4043

41-
If you're using another MCP-compatible client, you can manually configure it to use the MCP server for the Redpanda Cloud API. Follow these steps:
44+
If you're using another MCP-compatible client, manually configure it to use the Redpanda Cloud Management MCP Server. Follow these steps:
4245

4346
Add an MCP server entry to your client's configuration (example shown in JSON). Adjust paths for your system.
4447

45-
```json
48+
[,json]
49+
----
4650
"mcpServers": {
4751
"redpandaCloud": {
4852
"command": "rpk",
@@ -55,17 +59,15 @@ Add an MCP server entry to your client's configuration (example shown in JSON).
5559
]
5660
}
5761
}
58-
```
62+
----
5963
<1> Optional: The `--config` flag lets you target a specific `rpk.yaml`, which contains the configuration for connecting to your cluster. Always use the same configuration path as you used for `rpk cloud login` to ensure it has your token. Default paths vary by operating system. See the xref:reference:rpk/rpk-cloud/rpk-cloud-login.adoc[`rpk cloud login`] reference for the default paths.
6064

61-
[TIP]
62-
====
6365
You can also <<local, start the server manually in a terminal to observe logs and troubleshoot>>.
64-
====
66+
6567

6668
== Enable delete operations
6769

68-
Destructive operations are **disabled by default**. To allow delete operations, add `--allow-delete` to the MCP server invocation.
70+
The server disables destructive operations by default. To allow delete operations, add `--allow-delete` to the MCP server invocation.
6971

7072
CAUTION: Enabling delete operations permits actions like **deleting topics or clusters**. Restrict access to your AI client and double-check prompts.
7173

@@ -74,16 +76,18 @@ CAUTION: Enabling delete operations permits actions like **deleting topics or cl
7476
Auto-configured clients::
7577
+
7678
--
77-
```bash
79+
[,bash]
80+
----
7881
# Choose one
7982
rpk cloud mcp install --client claude --allow-delete
8083
rpk cloud mcp install --client claude-code --allow-delete
81-
```
84+
----
8285
--
8386
Manual configuration example::
8487
+
8588
--
86-
```json
89+
[,json]
90+
----
8791
"mcpServers": {
8892
"redpandaCloud": {
8993
"command": "rpk",
@@ -95,11 +99,11 @@ Manual configuration example::
9599
]
96100
}
97101
}
98-
```
102+
----
99103
--
100104
====
101105

102-
== Configuration locations and paths
106+
== Specify configuration file paths
103107

104108
All `rpk` commands accept a `--config` flag, which lets you specify the exact `rpk.yaml` configuration file to use for connecting to your Redpanda cluster. This flag overrides the default search path and ensures that the command uses the credentials and settings from the file you provide.
105109

@@ -141,23 +145,26 @@ rpk cloud login --client-id <service-account-client-id> --client-secret <service
141145

142146
== Troubleshooting
143147

144-
=== Quick checks
148+
149+
=== Verify your installation
145150

146151
. Make sure you are using at least version 25.2.3 of `rpk`.
147152
. If you see authentication errors, run `rpk cloud login` again.
148153
. Ensure you installed for the right client:
149154
+
150-
```bash
155+
[source,bash]
156+
----
151157
rpk cloud mcp install --client claude
152158
# or
153159
rpk cloud mcp install --client claude-code
154-
```
160+
----
155161
. If using another MCP client, verify your `mcpServers.redpandaCloud` entry (paths, JSON syntax, and args order).
156-
157-
. [[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:
162+
+
163+
[[local]]
164+
. 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:
158165

159166
+
160-
[source,bash]
167+
[,bash]
161168
----
162169
rpk cloud login
163170
rpk cloud mcp stdio
@@ -197,7 +204,7 @@ Your capabilities depend on your Redpanda Cloud account permissions. If an opera
197204

198205
=== Deletes not working
199206

200-
* By default, delete operations are **disabled**. Add `--allow-delete` to the server invocation (auto or manual configuration) and restart the client.
207+
* The server disables delete operations by default. Add `--allow-delete` to the server invocation (auto or manual configuration) and restart the client.
201208
* For auto-configured clients, you may need to edit the generated config or re-run the install command and adjust the entry.
202209

203210

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
= MCP Server for the Redpanda Cloud API
1+
= Redpanda Cloud Management MCP Server
22
:page-beta: true
3-
:description: Find links to information about the MCP server for the Redpanda Cloud API and its features for building and managing AI agents that can interact with your Redpanda Cloud account and clusters.
3+
:description: Find links to information about the Redpanda Cloud Management MCP Server and its features for building and managing AI agents that can interact with your Redpanda Cloud account and clusters.
44
:page-layout: index

modules/ai-agents/pages/mcp/local/overview.adoc

Lines changed: 21 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,33 @@
1-
= MCP Server for the Redpanda Cloud API
1+
= Redpanda Cloud Management MCP Server
22
:page-beta: true
3-
:description: Learn about the MCP server for the Redpanda Cloud API, which lets AI agents securely access and operate your Redpanda Cloud account and clusters.
3+
:description: Learn about the Redpanda Cloud Management MCP Server, which lets AI agents securely access and operate your Redpanda Cloud account and clusters.
44
:page-topic-type: overview
55
:personas: evaluator, ai_agent_developer, platform_admin
66
// Reader journey: "I'm new"
77
// Learning objectives - what readers should understand after reading this page:
8-
:learning-objective-1: Explain what the MCP server for the Redpanda Cloud API does
8+
:learning-objective-1: Explain what the Redpanda Cloud Management MCP Server does
99
:learning-objective-2: Identify what operations are available through MCP
1010
:learning-objective-3: Identify security considerations for MCP authentication
1111

12-
The MCP server for the Redpanda Cloud API lets AI agents securely access and operate your Redpanda Cloud account and clusters. MCP provides controlled access to:
12+
The Redpanda Cloud Management MCP Server lets AI agents securely access and operate your Redpanda Cloud account and clusters through natural language commands.
1313

14-
* link:https://docs.redpanda.com/api/doc/cloud-controlplane/[Control Plane] APIs, such as creating a Redpanda Cloud cluster or listing clusters.
15-
* link:https://docs.redpanda.com/api/doc/cloud-dataplane/[Data Plane] APIs, such as creating topics or listing topics.
14+
After reading this page, you will be able to:
1615

17-
By speaking natural language to your assistant, you can ask it to perform Redpanda operations on your behalf. The MCP server runs locally on your machine and authenticates to Redpanda Cloud using a Redpanda Cloud token.
16+
* [ ] {learning-objective-1}
17+
* [ ] {learning-objective-2}
18+
* [ ] {learning-objective-3}
1819
19-
image::shared:cloud-mcp.gif[A terminal window showing Claude Code invoking the MCP server for the Redpanda Cloud API to list topics in a cluster.]
20+
image::shared:cloud-mcp.gif[A terminal window showing Claude Code invoking the Redpanda Cloud Management MCP Server to list topics in a cluster.]
2021

2122
== What you can do
2223

24+
MCP provides controlled access to:
25+
26+
* link:https://docs.redpanda.com/api/doc/cloud-controlplane/[Control Plane] APIs, such as creating a Redpanda Cloud cluster or listing clusters.
27+
* link:https://docs.redpanda.com/api/doc/cloud-dataplane/[Data Plane] APIs, such as creating topics or listing topics.
28+
29+
The MCP server runs on your computer and authenticates to Redpanda Cloud using a Redpanda Cloud token.
30+
2331
You can do anything that's available in the Control Plane or Data Plane APIs. Typical requests you can make to your assistant once connected include:
2432

2533
* Create a Redpanda Cloud cluster named `dev-mcp`.
@@ -42,6 +50,8 @@ NOTE: The MCP server does **not** expose delete endpoints by default. You can en
4250

4351
=== Components
4452

53+
The Redpanda Cloud Management MCP Server requires these components:
54+
4555
* AI client (Claude, Claude Code, or any other MCP client) that connects to the MCP server.
4656
* Redpanda CLI (`rpk`) for obtaining a token and starting the MCP server.
4757
* Redpanda Cloud account that the MCP server can connect to and issue API requests.
@@ -56,13 +66,7 @@ MCP servers authenticate to Redpanda Cloud using your personal or service accoun
5666

5767
== Next steps
5868

59-
Continue your learning journey with these resources:
60-
61-
* xref:ai-agents:mcp/local/quickstart.adoc[MCP server for the Redpanda Cloud API quickstart]
62-
* xref:ai-agents:mcp/local/configuration.adoc[Configure the MCP server for the Redpanda Cloud API]
63-
64-
== Suggested reading
65-
66-
For more information, see these resources:
69+
* xref:ai-agents:mcp/local/quickstart.adoc[Redpanda Cloud Management MCP Server quickstart]
70+
* xref:ai-agents:mcp/local/configuration.adoc[Configure the Redpanda Cloud Management MCP Server]
6771

68-
* xref:home:ROOT:mcp-setup.adoc[Read-only MCP server for Redpanda docs]: Access Redpanda documentation and examples through AI agents
72+
TIP: The Redpanda documentation site has a read-only MCP server that provides access to Redpanda docs and examples. This server has no access to your Redpanda Cloud account or clusters. See xref:home:ROOT:mcp-setup.adoc[].

modules/ai-agents/pages/mcp/local/quickstart.adoc

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
= MCP Server for the Redpanda Cloud API Quickstart
1+
= Redpanda Cloud Management MCP Server Quickstart
22
:page-beta: true
3-
:description: Connect your Claude AI agent to your Redpanda Cloud account and clusters using the MCP server for the Redpanda Cloud API.
3+
:description: Connect your Claude AI agent to your Redpanda Cloud account and clusters using the Redpanda Cloud Management MCP Server.
44
:page-topic-type: tutorial
55
:personas: ai_agent_developer, platform_admin
66
// Reader journey: "I'm new" → first hands-on experience
@@ -9,15 +9,21 @@
99
:learning-objective-2: Install the MCP integration for Claude
1010
:learning-objective-3: Issue natural language commands to manage clusters
1111

12-
In this quickstart, you'll get your Claude AI agent talking to Redpanda Cloud using the xref:ai-agents:mcp/local/overview.adoc[MCP server for the Redpanda Cloud API].
12+
In this quickstart, you'll get your Claude AI agent talking to Redpanda Cloud using the xref:ai-agents:mcp/local/overview.adoc[Redpanda Cloud Management MCP Server].
1313

1414
If you're trying to deploy your own MCP server as a managed service inside your cluster, see xref:ai-agents:mcp/remote/quickstart.adoc[].
1515

16+
After completing this quickstart, you will be able to:
17+
18+
* [ ] {learning-objective-1}
19+
* [ ] {learning-objective-2}
20+
* [ ] {learning-objective-3}
21+
1622
== Prerequisites
1723

18-
* At least version 25.2.3 of xref:manage:rpk/rpk-install.adoc[`rpk` installed on your computer].
19-
* Access to a Redpanda Cloud account.
20-
* link:https://support.anthropic.com/en/articles/10065433-installing-claude-desktop[Claude] or link:https://docs.anthropic.com/en/docs/claude-code/setup[Claude Code] installed.
24+
* At least version 25.2.3 of xref:manage:rpk/rpk-install.adoc[`rpk` installed on your computer]
25+
* Access to a Redpanda Cloud account
26+
* link:https://support.anthropic.com/en/articles/10065433-installing-claude-desktop[Claude] or link:https://docs.anthropic.com/en/docs/claude-code/setup[Claude Code] installed
2127
+
2228
TIP: For other clients, see xref:ai-agents:mcp/local/configuration.adoc[].
2329

@@ -67,6 +73,4 @@ NOTE: The MCP server does *not* expose API endpoints that result in delete opera
6773

6874
== Next steps
6975

70-
Continue your learning journey with this resource:
71-
72-
* xref:ai-agents:mcp/local/configuration.adoc[]: Configure the MCP server for advanced use cases
76+
* xref:ai-agents:mcp/local/configuration.adoc[]

modules/ai-agents/pages/mcp/overview.adoc

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
= MCP Overview
2-
:description: Learn about Model Context Protocol (MCP) in Redpanda Cloud, including the two complementary options: the MCP server for the Redpanda Cloud API and Remote MCP.
1+
= MCP Servers for Redpanda Cloud Overview
2+
:description: Learn about Model Context Protocol (MCP) in Redpanda Cloud, including the two complementary options: the Redpanda Cloud Management MCP Server and Remote MCP.
33
:page-topic-type: overview
44
:personas: evaluator, ai_agent_developer
55
// Reader journey: "I'm new" - understanding the landscape
66
// Learning objectives - what readers should understand after reading this page:
77
:learning-objective-1: Describe what MCP enables for AI agents
8-
:learning-objective-2: Distinguish between local and remote MCP options
8+
:learning-objective-2: Distinguish between Redpanda Cloud Management MCP Server and Remote MCP
99
:learning-objective-3: Choose the right MCP option for your use case
1010

1111
This page introduces MCP in Redpanda Cloud and helps you choose the right option for your use case.
@@ -26,7 +26,7 @@ Without MCP, connecting AI to your business systems requires custom API code, au
2626

2727
Redpanda Cloud offers two complementary MCP options:
2828

29-
MCP server for the Redpanda Cloud API badge::[label=beta, tooltip={page-beta-text}]::
29+
Redpanda Cloud Management MCP Server badge::[label=beta, tooltip={page-beta-text}]::
3030
A pre-built server that gives AI agents access to Redpanda Cloud APIs. It runs on your computer and lets you manage clusters, topics, and other resources through natural language.
3131
+
3232
Example: "Create a cluster called `dev-analytics` with 3 brokers."
@@ -40,7 +40,7 @@ Example: "Analyze the last 100 orders and show me the top product categories."
4040

4141
[cols="1h,2,2"]
4242
|===
43-
| | MCP server for the Redpanda Cloud API | Remote MCP
43+
| | Redpanda Cloud Management MCP Server | Remote MCP
4444

4545
| Purpose
4646
| Operate your Redpanda Cloud account
@@ -67,7 +67,7 @@ Example: "Analyze the last 100 orders and show me the top product categories."
6767

6868
Choose based on what you want to accomplish:
6969

70-
**Use the MCP server for the Redpanda Cloud API** when you want to:
70+
**Use the Redpanda Cloud Management MCP Server** when you want to:
7171

7272
* Manage Redpanda Cloud resources without memorizing CLI commands
7373
* Quickly create test clusters, topics, or users
@@ -81,7 +81,7 @@ Choose based on what you want to accomplish:
8181
* Connect AI agents to external systems (databases, APIs, LLMs)
8282
* Run tools close to your data with managed infrastructure
8383

84-
You can use both options together. For example, use the MCP server for the Redpanda Cloud API to create a cluster, then deploy Remote MCP tools to analyze data in that cluster.
84+
You can use both options together. For example, use the Redpanda Cloud Management MCP Server to create a cluster, then deploy Remote MCP tools to analyze data in that cluster.
8585

8686
== Get started
8787

0 commit comments

Comments
 (0)