diff --git a/local-antora-playbook.yml b/local-antora-playbook.yml index 3cd0d159d..3e5b6c1d8 100644 --- a/local-antora-playbook.yml +++ b/local-antora-playbook.yml @@ -38,6 +38,7 @@ asciidoc: - '@redpanda-data/docs-extensions-and-macros/macros/rp-connect-components' - '@redpanda-data/docs-extensions-and-macros/macros/glossary' - '@redpanda-data/docs-extensions-and-macros/macros/config-ref' + - '@redpanda-data/docs-extensions-and-macros/macros/badge' - '@redpanda-data/docs-extensions-and-macros/macros/helm-ref' - '@redpanda-data/docs-extensions-and-macros/asciidoc-extensions/add-line-numbers-highlights' antora: diff --git a/modules/ROOT/nav.adoc b/modules/ROOT/nav.adoc index 72455d4ee..ce168d2ab 100644 --- a/modules/ROOT/nav.adoc +++ b/modules/ROOT/nav.adoc @@ -71,7 +71,7 @@ * xref:ai-agents:index.adoc[AI Agents] ** xref:ai-agents:mcp/overview.adoc[MCP Overview] -** xref:ai-agents:mcp/local/index.adoc[Local Redpanda Cloud MCP] +** xref:ai-agents:mcp/local/index.adoc[Redpanda Cloud Management MCP Server] *** xref:ai-agents:mcp/local/overview.adoc[Overview] *** xref:ai-agents:mcp/local/quickstart.adoc[Quickstart] *** xref:ai-agents:mcp/local/configuration.adoc[Configure] diff --git a/modules/ai-agents/pages/index.adoc b/modules/ai-agents/pages/index.adoc index c5dd8a04c..9ac867a96 100644 --- a/modules/ai-agents/pages/index.adoc +++ b/modules/ai-agents/pages/index.adoc @@ -5,10 +5,4 @@ AI agents are configurable assistants that autonomously perform specialist tasks by leveraging large language models (LLMs) and connecting to external data sources and tools. -Redpanda Cloud provides two complementary Model Context Protocol (MCP) options to help you build AI agents: - -MCP server for the Redpanda Cloud API badge::[label=beta, tooltip={page-beta-text}]:: -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. - -Remote MCP:: -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. \ No newline at end of file +Redpanda Cloud provides two complementary Model Context Protocol (MCP) options to help you build AI agents. diff --git a/modules/ai-agents/pages/mcp/local/configuration.adoc b/modules/ai-agents/pages/mcp/local/configuration.adoc index 9bcaf55fe..134c50b0c 100644 --- a/modules/ai-agents/pages/mcp/local/configuration.adoc +++ b/modules/ai-agents/pages/mcp/local/configuration.adoc @@ -1,48 +1,52 @@ -= Configure the MCP Server for the Redpanda Cloud API += Configure the Redpanda Cloud Management MCP Server :page-beta: true -:description: Learn how to configure the MCP server for the Redpanda Cloud API, including auto and manual client setup, enabling deletes, and security considerations. +:description: Learn how to configure the Redpanda Cloud Management MCP Server, including auto and manual client setup, enabling deletes, and security considerations. :page-topic-type: how-to :personas: ai_agent_developer, platform_admin // Reader journey: "I customize and configure" // Learning objectives - what readers can learn from this page: -:learning-objective-1: Configure MCP clients manually +:learning-objective-1: Configure MCP clients :learning-objective-2: Enable delete operations safely :learning-objective-3: Troubleshoot common configuration issues -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. +After installing the Redpanda Cloud Management MCP Server, you can configure it for different AI clients, customize security settings, and troubleshoot common issues. -== Prerequisites +After reading this page, you will be able to: -* At least version 25.2.3 of xref:manage:rpk/rpk-install.adoc[`rpk` installed on your computer]. -* Access to a Redpanda Cloud account. -* Supported AI client (Claude, Claude Code, or other MCP-compatible client). +* [ ] {learning-objective-1} +* [ ] {learning-objective-2} +* [ ] {learning-objective-3} -== Endpoint availability +== Prerequisites -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`. +* At least version 25.2.3 of xref:manage:rpk/rpk-install.adoc[`rpk` installed on your local machine] +* Access to a Redpanda Cloud account +* An MCP-compatible AI client such as Claude, Claude Code, or another tool that supports MCP -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]. +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]. -== Auto-configured clients (Claude and Claude Code) +== Install the integration for Claude or Claude Code 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]. For Claude and Claude Code, run one of these commands: -```bash +[source,bash] +---- # Choose one rpk cloud mcp install --client claude rpk cloud mcp install --client claude-code -``` +---- If you need to update the integration, re-run the install command for your client. -== Manual configuration for other MCP clients +== Configure other MCP clients manually -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: +If you're using another MCP-compatible client, manually configure it to use the Redpanda Cloud Management MCP Server. Follow these steps: Add an MCP server entry to your client's configuration (example shown in JSON). Adjust paths for your system. -```json +[,json] +---- "mcpServers": { "redpandaCloud": { "command": "rpk", @@ -55,17 +59,15 @@ Add an MCP server entry to your client's configuration (example shown in JSON). ] } } -``` +---- <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. -[TIP] -==== You can also <>. -==== + == Enable delete operations -Destructive operations are **disabled by default**. To allow delete operations, add `--allow-delete` to the MCP server invocation. +The server disables destructive operations by default. To allow delete operations, add `--allow-delete` to the MCP server invocation. CAUTION: Enabling delete operations permits actions like **deleting topics or clusters**. Restrict access to your AI client and double-check prompts. @@ -74,16 +76,18 @@ CAUTION: Enabling delete operations permits actions like **deleting topics or cl Auto-configured clients:: + -- -```bash +[,bash] +---- # Choose one rpk cloud mcp install --client claude --allow-delete rpk cloud mcp install --client claude-code --allow-delete -``` +---- -- Manual configuration example:: + -- -```json +[,json] +---- "mcpServers": { "redpandaCloud": { "command": "rpk", @@ -95,11 +99,11 @@ Manual configuration example:: ] } } -``` +---- -- ==== -== Configuration locations and paths +== Specify configuration file paths 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. @@ -141,23 +145,26 @@ rpk cloud login --client-id --client-secret /v1/redpanda-connect/mcp-servers//v1/redpanda-connect/mcp-servers//v1/redpanda-connect/mcp-servers/