You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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>
Copy file name to clipboardExpand all lines: modules/ai-agents/pages/index.adoc
+1-7Lines changed: 1 addition & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,10 +5,4 @@
5
5
6
6
AI agents are configurable assistants that autonomously perform specialist tasks by leveraging large language models (LLMs) and connecting to external data sources and tools.
7
7
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.
Copy file name to clipboardExpand all lines: modules/ai-agents/pages/mcp/local/configuration.adoc
+41-34Lines changed: 41 additions & 34 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,48 +1,52 @@
1
-
= Configure the MCP Server for the Redpanda Cloud API
1
+
= Configure the Redpanda Cloud Management MCP Server
2
2
: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.
4
4
:page-topic-type: how-to
5
5
:personas: ai_agent_developer, platform_admin
6
6
// Reader journey: "I customize and configure"
7
7
// Learning objectives - what readers can learn from this page:
:learning-objective-3: Troubleshoot common configuration issues
11
11
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.
13
13
14
-
== Prerequisites
14
+
After reading this page, you will be able to:
15
15
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}
19
19
20
-
== Endpoint availability
20
+
== Prerequisites
21
21
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
23
25
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].
25
27
26
-
== Auto-configured clients (Claude and Claude Code)
28
+
== Install the integration for Claude or Claude Code
27
29
28
30
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].
29
31
For Claude and Claude Code, run one of these commands:
30
32
31
-
```bash
33
+
[source,bash]
34
+
----
32
35
# Choose one
33
36
rpk cloud mcp install --client claude
34
37
rpk cloud mcp install --client claude-code
35
-
```
38
+
----
36
39
37
40
If you need to update the integration, re-run the install command for your client.
38
41
39
-
== Manual configuration for other MCP clients
42
+
== Configure other MCP clients manually
40
43
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:
42
45
43
46
Add an MCP server entry to your client's configuration (example shown in JSON). Adjust paths for your system.
44
47
45
-
```json
48
+
[,json]
49
+
----
46
50
"mcpServers": {
47
51
"redpandaCloud": {
48
52
"command": "rpk",
@@ -55,17 +59,15 @@ Add an MCP server entry to your client's configuration (example shown in JSON).
55
59
]
56
60
}
57
61
}
58
-
```
62
+
----
59
63
<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.
60
64
61
-
[TIP]
62
-
====
63
65
You can also <<local, start the server manually in a terminal to observe logs and troubleshoot>>.
64
-
====
66
+
65
67
66
68
== Enable delete operations
67
69
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.
69
71
70
72
CAUTION: Enabling delete operations permits actions like **deleting topics or clusters**. Restrict access to your AI client and double-check prompts.
71
73
@@ -74,16 +76,18 @@ CAUTION: Enabling delete operations permits actions like **deleting topics or cl
74
76
Auto-configured clients::
75
77
+
76
78
--
77
-
```bash
79
+
[,bash]
80
+
----
78
81
# Choose one
79
82
rpk cloud mcp install --client claude --allow-delete
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.
. Make sure you are using at least version 25.2.3 of `rpk`.
147
152
. If you see authentication errors, run `rpk cloud login` again.
148
153
. Ensure you installed for the right client:
149
154
+
150
-
```bash
155
+
[source,bash]
156
+
----
151
157
rpk cloud mcp install --client claude
152
158
# or
153
159
rpk cloud mcp install --client claude-code
154
-
```
160
+
----
155
161
. 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:
158
165
159
166
+
160
-
[source,bash]
167
+
[,bash]
161
168
----
162
169
rpk cloud login
163
170
rpk cloud mcp stdio
@@ -197,7 +204,7 @@ Your capabilities depend on your Redpanda Cloud account permissions. If an opera
197
204
198
205
=== Deletes not working
199
206
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.
201
208
* For auto-configured clients, you may need to edit the generated config or re-run the install command and adjust the entry.
: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.
Copy file name to clipboardExpand all lines: modules/ai-agents/pages/mcp/local/overview.adoc
+21-17Lines changed: 21 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,25 +1,33 @@
1
-
= MCP Server for the Redpanda Cloud API
1
+
= Redpanda Cloud Management MCP Server
2
2
: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.
// 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
9
9
:learning-objective-2: Identify what operations are available through MCP
10
10
:learning-objective-3: Identify security considerations for MCP authentication
11
11
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.
13
13
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:
16
15
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}
18
19
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.]
20
21
21
22
== What you can do
22
23
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
+
23
31
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:
24
32
25
33
* 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
42
50
43
51
=== Components
44
52
53
+
The Redpanda Cloud Management MCP Server requires these components:
54
+
45
55
* AI client (Claude, Claude Code, or any other MCP client) that connects to the MCP server.
46
56
* Redpanda CLI (`rpk`) for obtaining a token and starting the MCP server.
47
57
* 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
56
66
57
67
== Next steps
58
68
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]
67
71
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[].
Copy file name to clipboardExpand all lines: modules/ai-agents/pages/mcp/local/quickstart.adoc
+13-9Lines changed: 13 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
-
= MCP Server for the Redpanda Cloud API Quickstart
1
+
= Redpanda Cloud Management MCP Server Quickstart
2
2
: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.
4
4
:page-topic-type: tutorial
5
5
:personas: ai_agent_developer, platform_admin
6
6
// Reader journey: "I'm new" → first hands-on experience
@@ -9,15 +9,21 @@
9
9
:learning-objective-2: Install the MCP integration for Claude
10
10
:learning-objective-3: Issue natural language commands to manage clusters
11
11
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].
13
13
14
14
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[].
15
15
16
+
After completing this quickstart, you will be able to:
17
+
18
+
* [ ] {learning-objective-1}
19
+
* [ ] {learning-objective-2}
20
+
* [ ] {learning-objective-3}
21
+
16
22
== Prerequisites
17
23
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
21
27
+
22
28
TIP: For other clients, see xref:ai-agents:mcp/local/configuration.adoc[].
23
29
@@ -67,6 +73,4 @@ NOTE: The MCP server does *not* expose API endpoints that result in delete opera
67
73
68
74
== Next steps
69
75
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
Copy file name to clipboardExpand all lines: modules/ai-agents/pages/mcp/overview.adoc
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff 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.
3
3
:page-topic-type: overview
4
4
:personas: evaluator, ai_agent_developer
5
5
// Reader journey: "I'm new" - understanding the landscape
6
6
// Learning objectives - what readers should understand after reading this page:
7
7
: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
9
9
:learning-objective-3: Choose the right MCP option for your use case
10
10
11
11
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
26
26
27
27
Redpanda Cloud offers two complementary MCP options:
28
28
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}]::
30
30
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.
31
31
+
32
32
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."
40
40
41
41
[cols="1h,2,2"]
42
42
|===
43
-
| | MCP server for the Redpanda Cloud API | Remote MCP
43
+
| | Redpanda Cloud Management MCP Server | Remote MCP
44
44
45
45
| Purpose
46
46
| Operate your Redpanda Cloud account
@@ -67,7 +67,7 @@ Example: "Analyze the last 100 orders and show me the top product categories."
67
67
68
68
Choose based on what you want to accomplish:
69
69
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:
71
71
72
72
* Manage Redpanda Cloud resources without memorizing CLI commands
73
73
* Quickly create test clusters, topics, or users
@@ -81,7 +81,7 @@ Choose based on what you want to accomplish:
81
81
* Connect AI agents to external systems (databases, APIs, LLMs)
82
82
* Run tools close to your data with managed infrastructure
83
83
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.
0 commit comments