Skip to content

Commit 3a665a5

Browse files
committed
Minor fixes
1 parent 482be19 commit 3a665a5

3 files changed

Lines changed: 18 additions & 38 deletions

File tree

modules/ai-agents/pages/mcp/remote/admin-guide.adoc

Lines changed: 12 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -7,44 +7,25 @@ This guide provides an overview of administrative tasks for Remote MCP servers.
77

88
You must have an existing MCP server. If you do not have one, see xref:ai-agents:mcp/remote/quickstart.adoc[].
99

10-
== Administrative tasks
11-
12-
=== Server lifecycle management
10+
== Server lifecycle management
1311

1412
Manage the basic lifecycle of your MCP servers, including editing configurations, pausing to save costs, and permanent deletion.
1513

16-
See xref:ai-agents:mcp/remote/manage-servers.adoc[] to learn how to:
17-
18-
* Edit an MCP server's configuration, metadata, or tools
19-
* Stop (pause) an MCP server to release compute resources while preserving configuration
20-
* Start a stopped MCP server to restore functionality
21-
* Delete an MCP server permanently
14+
See xref:ai-agents:mcp/remote/manage-servers.adoc[].
2215

23-
=== Resource scaling
16+
== Resource scaling
2417

2518
Adjust your MCP server's compute resources to match workload demands and optimize costs. Resource allocation directly affects your billing charges.
2619

27-
See xref:ai-agents:mcp/remote/scale-resources.adoc[] to learn how to:
28-
29-
* Scale resources up during peak usage periods
30-
* Scale resources down during quieter times to optimize costs
31-
* Choose the appropriate resource size for your workload (XSmall through XLarge)
32-
* Use the Cloud UI or Data Plane API to adjust resource allocation
33-
34-
=== Monitoring and observability
20+
See xref:ai-agents:mcp/remote/scale-resources.adoc[].
3521

36-
Monitor your MCP server's activity using OpenTelemetry traces automatically emitted to the `redpanda.otel_traces` topic. Track tool invocations, measure performance, debug failures, and integrate with observability platforms.
22+
== Monitoring and observability
3723

38-
See xref:ai-agents:mcp/remote/monitor-activity.adoc[] to learn how to:
24+
Monitor your MCP server's activity using OpenTelemetry traces. Track tool invocations, measure performance, debug failures, and integrate with observability platforms.
3925

40-
* Consume and analyze trace data from the `redpanda.otel_traces` topic
41-
* Track which tools are being called and how often
42-
* Measure tool execution times and identify performance issues
43-
* Debug failures using error traces and status codes
44-
* Integrate with Grafana Tempo, Datadog, or custom dashboards
45-
* Follow best practices for retention, sampling, and alerting
26+
See xref:ai-agents:mcp/remote/monitor-activity.adoc[].
4627

47-
== Working with the Data Plane API
28+
== Data Plane API
4829

4930
All administrative tasks can be performed through both the Redpanda Cloud Console UI and the Data Plane API. The Data Plane API is useful for:
5031

@@ -58,10 +39,10 @@ To use the Data Plane API:
5839
. link:/api/doc/cloud-dataplane/topic/topic-quickstart[Authenticate and get the base URL] for the Data Plane API.
5940
. Use the appropriate endpoint for your task:
6041
+
61-
* link:/api/doc/cloud-dataplane/operation/operation-mcpserverservice_updatemcpserver[`PATCH /v1/redpanda-connect/mcp-servers/\{mcp_server_id}`] - Update configuration
62-
* link:/api/doc/cloud-dataplane/operation/operation-mcpserverservice_stopmcpserver[`POST /v1/redpanda-connect/mcp-servers/\{mcp_server_id}:stop`] - Stop server
63-
* link:/api/doc/cloud-dataplane/operation/operation-mcpserverservice_startmcpserver[`POST /v1/redpanda-connect/mcp-servers/\{mcp_server_id}:start`] - Start server
64-
* link:/api/doc/cloud-dataplane/operation/operation-mcpserverservice_deletemcpserver[`DELETE /v1/redpanda-connect/mcp-servers/\{mcp_server_id}`] - Delete server
42+
* link:/api/doc/cloud-dataplane/operation/operation-mcpserverservice_updatemcpserver[`PATCH /v1/redpanda-connect/mcp-servers/\{mcp_server_id}`]: Update configuration
43+
* link:/api/doc/cloud-dataplane/operation/operation-mcpserverservice_stopmcpserver[`POST /v1/redpanda-connect/mcp-servers/\{mcp_server_id}:stop`]: Stop server
44+
* link:/api/doc/cloud-dataplane/operation/operation-mcpserverservice_startmcpserver[`POST /v1/redpanda-connect/mcp-servers/\{mcp_server_id}:start`]: Start server
45+
* link:/api/doc/cloud-dataplane/operation/operation-mcpserverservice_deletemcpserver[`DELETE /v1/redpanda-connect/mcp-servers/\{mcp_server_id}`]: Delete server
6546

6647
[NOTE]
6748
====

modules/ai-agents/pages/mcp/remote/monitor-activity.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Each span represents a unit of work performed by your MCP server, such as:
2525

2626
=== Topic configuration and lifecycle
2727

28-
The `redpanda.otel_traces` topic is managed automatically by Redpanda and follows a predefined retention policy. Configuration changes to this system-managed topic are not supported and will be reconciled back to the default settings.
28+
The `redpanda.otel_traces` topic is managed automatically by Redpanda and follows a predefined retention policy. Configuration changes to this topic are not supported. If you modify settings, Redpanda reverts them to the default values.
2929

3030
The topic persists in your cluster even after all MCP servers are deleted, allowing you to retain historical trace data for analysis.
3131

@@ -136,9 +136,9 @@ All MCP servers in a cluster write traces to the same `redpanda.otel_traces` top
136136

137137
* When `instrumentationScope.name` is `rpcn-mcp`, the span represents an MCP tool invocation.
138138
* The `name` field contains the MCP tool name (for example, `weather`, `http_processor`, `generate_input`).
139-
* Child spans reference their parent via `parentSpanId` and share the same `traceId`
139+
* Child spans reference their parent using `parentSpanId` and share the same `traceId`
140140

141-
For example, a span with `instrumentationScope.name: "rpcn-mcp"` and `name: "weather"` indicates the `weather` tool was invoked. Child spans created by Redpanda Connect components show `instrumentationScope.name: "benthos"` and represent internal processing steps.
141+
For example, a span with `instrumentationScope.name: "rpcn-mcp"` and `name: "weather"` indicates the `weather` tool was invoked. Child spans created by Redpanda Connect components show `instrumentationScope.name: "redpanda-connect"` and represent internal processing steps.
142142

143143
=== Real trace examples
144144

@@ -185,7 +185,7 @@ The parent span (`http_processor`) has child spans showing the processing pipeli
185185
"attributes": [],
186186
"endTimeUnixNano": "1765198424659619511",
187187
"flags": 1,
188-
"instrumentationScope": {"name": "benthos"},
188+
"instrumentationScope": {"name": "redpanda-connect"},
189189
"kind": 1,
190190
"name": "http",
191191
"parentSpanId": "43ad6bc31a826afd",
@@ -223,7 +223,7 @@ This trace shows an HTTP request that encountered an error during execution:
223223
}
224224
],
225225
"flags": 1,
226-
"instrumentationScope": {"name": "benthos"},
226+
"instrumentationScope": {"name": "redpanda-connect"},
227227
"kind": 1,
228228
"name": "http_request",
229229
"parentSpanId": "43ad6bc31a826afd",

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
= About Remote MCP Servers for Redpanda Cloud
22
:description: Discover how AI assistants can interact with your streaming data and how to connect them to Redpanda Cloud.
33

4-
5-
Remote MCP (Model Context Protocol) servers are managed, hosted MCP servers that you can write and run inside your Redpanda Cloud cluster. They let you expose your data, analytics, and automation pipelines as AI-consumable tools with no custom API code. MCP servers bridge your business logic to AI agents using the open MCP standard, so you can:
4+
Remote MCP (Model Context Protocol) servers are hosted MCP servers that run inside your Redpanda Cloud cluster. They let you expose your data, analytics, and automation pipelines as AI-consumable tools with no custom API code. MCP servers bridge your business logic to AI agents using the open MCP standard, so you can:
65

76
* Make your data and workflows accessible to AI assistants and LLMs, safely and on your terms.
87
* Accelerate automation and insight by letting AI trigger real business actions.

0 commit comments

Comments
 (0)