Skip to content

Commit b128b48

Browse files
committed
docs(mcp-servers): rewrite MCP Servers pages for ADP GA
Greenfield rewrite of the MCP Servers section for the Agentic Data Plane GA (2026-06-15). Bundles three master-plan workflows: #3 Create MCP server (DOC-2111), #9 Register remote/self-hosted MCP (DOC-2117), #10 User-delegated OAuth for MCP (DOC-2118). Changes: * Delete legacy MCP content migrated from cloud-docs (the YAML-pipeline- authoring era): mcp/pages/remote/ (13 pages), mcp/pages/overview.adoc, mcp/pages/local.adoc, mcp/examples/mcp-tools/ (42 YAML files + test-mcp-tools.sh). The cloud-docs equivalents were removed in redpanda-data/cloud-docs#562; this is the same cleanup applied to adp-docs main, where the migration pre-dated #562. * Rewrite mcp/pages/index.adoc as the MCP Servers landing — frames managed + self-managed backends, lists the four ADP-UI top-level areas, points at Cloud Management MCP as a peer. * Stub the 4 must-ship how-tos (create-server, register-remote, user-delegated-oauth, test-tools) + the managed-catalog reference, with full outlines and // TODO: markers for live walkthroughs on adp-production. Auth section uses the new RemoteMCPConfig auth oneof (none / static_key / token_passthrough / service_account_oauth / user_oauth); credential_mode and the CredentialMode enum are gone post- proto-rewrite. * Stub the 5 should-ship managed deep-dives (sql, kafka, slack, jira, openapi). All follow the shared 7-section structure (what the server does -> prereqs -> configure -> test -> auth -> use with agents -> troubleshooting). Live-walkthrough TODOs throughout. * managed-catalog.adoc lists all 27 user-facing managed types from apps/aigw/internal/mcp/managed/mcps/*/register_mcp.go, grouped by ManagedMCPCategory (AI / AWS / Communication / Database / Google / Streaming / Utility), with deep-dive links for the 5 with dedicated pages. * Update modules/ROOT/nav.adoc — replace the legacy Remote/Local subsections with the new flat MCP Servers structure; promote Redpanda Cloud Management MCP Server to a peer top-level section. * Cascade: retarget xrefs in modules/agents/, modules/observability/, and modules/ROOT/pages/adp-overview.adoc that pointed at deleted mcp:remote/* paths. Targets: mcp:remote/overview.adoc -> mcp:index.adoc; mcp:remote/quickstart.adoc + create-tool.adoc -> mcp:create-server.adoc; mcp:remote/register-external.adoc -> mcp:register-remote.adoc; mcp:remote/oauth-user-delegated.adoc -> mcp:user-delegated-oauth.adoc; mcp:remote/monitor-mcp-servers.adoc -> mcp:test-tools.adoc; mcp:remote/{patterns,best-practices,scale,troubleshooting}.adoc and mcp:overview.adoc -> mcp:index.adoc (no direct equivalents). Beta target (2026-05-15) is best-effort; firm commitment is GA on 2026-06-15. // TODO: markers throughout will be resolved through live walkthroughs on adp-production in subsequent commits. Refs: DOC-2111, DOC-2117, DOC-2118 Plan: https://redpandadata.atlassian.net/wiki/spaces/DOC/pages/1869185054 Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> # Conflicts: # modules/observability/pages/concepts.adoc # modules/observability/pages/transcripts.adoc
1 parent 4f1bb18 commit b128b48

85 files changed

Lines changed: 1433 additions & 3798 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

modules/ROOT/nav.adoc

Lines changed: 15 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -23,24 +23,21 @@
2323
**** xref:agents:tutorials/customer-support-agent.adoc[Customer support agent]
2424
**** xref:agents:tutorials/transaction-dispute-resolution.adoc[Transaction dispute resolution]
2525
* MCP Servers
26-
** xref:mcp:overview.adoc[Overview]
27-
*** Remote MCP
28-
**** xref:mcp:remote/overview.adoc[Overview]
29-
**** xref:mcp:remote/quickstart.adoc[Quickstart]
30-
**** xref:mcp:remote/concepts.adoc[Concepts]
31-
**** xref:mcp:remote/create-tool.adoc[Create tools]
32-
**** xref:mcp:remote/register-external.adoc[Register a self-hosted server]
33-
**** xref:mcp:remote/oauth-user-delegated.adoc[User-delegated OAuth]
34-
**** xref:mcp:remote/patterns.adoc[Patterns]
35-
**** xref:mcp:remote/best-practices.adoc[Best practices]
36-
**** xref:mcp:remote/manage-servers.adoc[Manage servers]
37-
**** xref:mcp:remote/monitor-mcp-servers.adoc[Monitor servers]
38-
**** xref:mcp:remote/scale.adoc[Scaling]
39-
**** xref:mcp:remote/troubleshooting.adoc[Troubleshooting]
40-
*** Local MCP
41-
**** xref:mcp:local/overview.adoc[Overview]
42-
**** xref:mcp:local/quickstart.adoc[Quickstart]
43-
**** xref:mcp:local/configuration.adoc[Configuration]
26+
** xref:mcp:index.adoc[Overview]
27+
** xref:mcp:create-server.adoc[Create a server]
28+
** xref:mcp:register-remote.adoc[Register a self-managed server]
29+
** xref:mcp:user-delegated-oauth.adoc[User-delegated OAuth]
30+
** xref:mcp:test-tools.adoc[Test a server's tools]
31+
** xref:mcp:managed-catalog.adoc[Managed catalog]
32+
*** xref:mcp:managed/sql.adoc[SQL]
33+
*** xref:mcp:managed/kafka.adoc[Kafka]
34+
*** xref:mcp:managed/slack.adoc[Slack]
35+
*** xref:mcp:managed/jira.adoc[Jira]
36+
*** xref:mcp:managed/openapi.adoc[OpenAPI]
37+
* Redpanda Cloud Management MCP Server
38+
** xref:mcp:local/index.adoc[Overview]
39+
** xref:mcp:local/quickstart.adoc[Quickstart]
40+
** xref:mcp:local/configuration.adoc[Configuration]
4441
* AI Gateway
4542
** xref:ai-gateway:overview.adoc[Overview]
4643
** xref:ai-gateway:gateway-quickstart.adoc[Quickstart]

modules/ROOT/pages/adp-overview.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Under the hood, MCP servers wrap the same proven connectors that power some of t
4040

4141
With over 300 connectors and real-time debugging capabilities, you reduce integration time while getting enterprise-grade security. You can reuse your existing infrastructure and data sources rather than building new integrations from scratch.
4242

43-
For more information, see xref:mcp:overview.adoc[MCP Servers Overview].
43+
For more information, see xref:mcp:index.adoc[MCP Servers Overview].
4444

4545
== Transcripts
4646

@@ -85,6 +85,6 @@ Some ways organizations can leverage Redpanda ADP include:
8585
== Next steps
8686

8787
* xref:agents:overview.adoc[AI Agents Overview]
88-
* xref:mcp:overview.adoc[MCP Server Overview]
88+
* xref:mcp:index.adoc[MCP Server Overview]
8989
* xref:observability:concepts.adoc[Transcripts Overview]
9090
* xref:ai-gateway:overview.adoc[AI Gateway Overview]

modules/agents/pages/architecture-patterns.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@ This pattern fails because:
167167
* Tool descriptions compete for limited prompt space
168168
* The agent invokes wrong tools with similar names, wasting iteration budget on selection mistakes
169169

170-
Limit tools per agent to 10-15 for optimal performance. Agents with more than 20-25 tools often show degraded tool selection accuracy. Use subagents to partition tools by domain. For tool design patterns, see xref:mcp:remote/patterns.adoc[].
170+
Limit tools per agent to 10-15 for optimal performance. Agents with more than 20-25 tools often show degraded tool selection accuracy. Use subagents to partition tools by domain. For tool design patterns, see xref:mcp:index.adoc[].
171171

172172
=== Premature A2A splitting
173173

@@ -259,6 +259,6 @@ Provide clear error messages to users. Log errors for debugging.
259259

260260
* xref:integration-overview.adoc[]
261261
* xref:a2a-concepts.adoc[]
262-
* xref:mcp:remote/patterns.adoc[]
262+
* xref:mcp:index.adoc[]
263263
* xref:overview.adoc[]
264-
* xref:mcp:remote/best-practices.adoc[]
264+
* xref:mcp:index.adoc[]

modules/agents/pages/concepts.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ Tool design affects agent behavior. Coarse-grained tools that do many things res
132132

133133
Choose granularity based on how often you'll reuse tool logic across workflows, whether intermediate results help with debugging, and how much control you want over tool invocation order.
134134

135-
For tool design guidance, see xref:mcp:remote/best-practices.adoc[].
135+
For tool design guidance, see xref:mcp:index.adoc[].
136136

137137
== Context and state management
138138

@@ -159,4 +159,4 @@ include::ROOT:partial$service-account-authorization.adoc[]
159159
* xref:architecture-patterns.adoc[]
160160
* xref:quickstart.adoc[]
161161
* xref:system-prompts.adoc[]
162-
* xref:mcp:remote/best-practices.adoc[]
162+
* xref:mcp:index.adoc[]

modules/agents/pages/create-agent.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ After reading this page, you will be able to:
2020

2121
* A xref:redpanda-cloud:get-started:cluster-types/byoc/index.adoc[BYOC cluster].
2222
* xref:ai-gateway:gateway-quickstart.adoc[AI Gateway configured] with at least one LLM provider enabled.
23-
* At least one xref:mcp:remote/overview.adoc[Remote MCP server] deployed with tools.
23+
* At least one xref:mcp:index.adoc[Remote MCP server] deployed with tools.
2424
* System prompt prepared (see xref:system-prompts.adoc[System Prompt Best Practices]).
2525

2626
== Access the agents UI
@@ -276,6 +276,6 @@ Here are example configurations for different agent types:
276276

277277
* xref:integration-overview.adoc[]
278278
* xref:system-prompts.adoc[]
279-
* xref:mcp:remote/create-tool.adoc[]
279+
* xref:mcp:create-server.adoc[]
280280
* xref:architecture-patterns.adoc[]
281281
* xref:troubleshoot.adoc[]

modules/agents/pages/integration-overview.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Redpanda Cloud supports three primary integration scenarios based on who initiat
2727
| Agent needs capabilities
2828
| Your agent invokes MCP tools to fetch data, call APIs, or access external systems on-demand
2929
| Agent-initiated, synchronous, interactive workflows
30-
| xref:mcp:remote/patterns.adoc[]
30+
| xref:mcp:index.adoc[]
3131

3232
| Pipeline processes events
3333
| Your Redpanda Connect pipeline invokes agents for each event in a stream using the `a2a_message` processor
@@ -55,7 +55,7 @@ This pattern works well for interactive workflows: customer support lookups, app
5555

5656
Avoid MCP tools for high-volume stream processing or automated workflows without user interaction. Use pipeline-initiated integration instead.
5757

58-
For implementation details, see xref:mcp:remote/patterns.adoc[].
58+
For implementation details, see xref:mcp:index.adoc[].
5959

6060
[[pipeline-processes-events]]
6161
=== Pipeline processes events (`a2a_message`)
@@ -126,5 +126,5 @@ Access tokens grant full access to the agent. Anyone with a valid token can send
126126
== Next steps
127127

128128
* xref:a2a-concepts.adoc[]
129-
* xref:mcp:remote/patterns.adoc[]
129+
* xref:mcp:index.adoc[]
130130
* xref:pipeline-integration-patterns.adoc[]

modules/agents/pages/overview.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ When you create an agent, you configure the components through the Redpanda Clou
2727

2828
* *System prompt*: Defines the agent's role, responsibilities, and constraints
2929
* *LLM*: Interprets user intent and decides which tools to invoke
30-
* *Tools*: External capabilities exposed through the xref:mcp:remote/overview.adoc[Model Context Protocol (MCP)]
30+
* *Tools*: External capabilities exposed through the xref:mcp:index.adoc[Model Context Protocol (MCP)]
3131
* *Context*: Conversation history, tool results, and real-time events from Redpanda topics
3232

3333
Agents can invoke Redpanda Connect components as tools on-demand. Redpanda Connect pipelines can also invoke agents for event-driven processing. This bidirectional integration supports both interactive workflows and automated streaming.
@@ -38,7 +38,7 @@ For a deeper understanding of how agents execute, manage context, and maintain s
3838

3939
== Key benefits
4040

41-
A declarative approach means you configure agent behavior instead of coding it, with access to 300+ built-in Redpanda Connect connectors for data sources, APIs, and services. Real-time streaming data ensures agents access live events instead of batch snapshots. xref:mcp:remote/overview.adoc[Remote MCP] support enables standardized tool access. Managed infrastructure handles deployment, scaling, and security for you. Low-latency execution means tools run close to your data. Integrated secrets management securely stores API keys and credentials.
41+
A declarative approach means you configure agent behavior instead of coding it, with access to 300+ built-in Redpanda Connect connectors for data sources, APIs, and services. Real-time streaming data ensures agents access live events instead of batch snapshots. xref:mcp:index.adoc[Remote MCP] support enables standardized tool access. Managed infrastructure handles deployment, scaling, and security for you. Low-latency execution means tools run close to your data. Integrated secrets management securely stores API keys and credentials.
4242

4343
== Use cases
4444

modules/agents/pages/pipeline-integration-patterns.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ This pipeline:
139139

140140
== Next steps
141141

142-
* xref:mcp:remote/patterns.adoc[]
142+
* xref:mcp:index.adoc[]
143143
* xref:integration-overview.adoc[]
144144
* xref:a2a-concepts.adoc[]
145145
* xref:redpanda-cloud:develop:connect/components/processors/about.adoc[]

modules/agents/pages/quickstart.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ After completing this quickstart, you will be able to:
2323

2424
* xref:ai-gateway:gateway-quickstart.adoc[AI Gateway configured] with at least one LLM provider enabled (OpenAI, Anthropic, or Google AI)
2525

26-
* Completed the xref:mcp:remote/quickstart.adoc[Remote MCP Quickstart] to create an MCP server with the following tools deployed:
26+
* Completed the xref:mcp:create-server.adoc[Remote MCP Quickstart] to create an MCP server with the following tools deployed:
2727
+
2828
** `generate_input`: Generates fake user event data
2929
** `redpanda_output`: Publishes data to Redpanda topics
@@ -185,4 +185,4 @@ You've created an agent that orchestrates MCP tools through natural language. Ex
185185
* xref:create-agent.adoc[]
186186
* xref:system-prompts.adoc[]
187187
* xref:architecture-patterns.adoc[]
188-
* xref:mcp:remote/patterns.adoc[]
188+
* xref:mcp:index.adoc[]

modules/agents/pages/system-prompts.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -423,4 +423,4 @@ Decision criteria enable reliable tool selection based on request context.
423423

424424
* xref:quickstart.adoc[]
425425
* xref:overview.adoc[]
426-
* xref:mcp:remote/best-practices.adoc[]
426+
* xref:mcp:index.adoc[]

0 commit comments

Comments
 (0)