Skip to content

Commit 5085a08

Browse files
committed
cleanup
1 parent 6997ef3 commit 5085a08

9 files changed

Lines changed: 50 additions & 57 deletions

File tree

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
:learning-objective-2: Describe how each component addresses enterprise governance and reliability requirements
88
:learning-objective-3: Determine whether Redpanda ADP fits your organization's requirements for AI agent deployment
99

10-
glossterm:AI agent[,AI agents] are moving from demos to production. Enterprises need governance, reliability, and cost control to deploy them safely. Redpanda Agentic Data Plane (ADP) combine a streaming-native immutable log, 300+ proven data connectors, and declarative glossterm:AI agent[,AI agents] into a unified platform with built-in compliance-grade audit trails.
10+
glossterm:AI agent[,AI agents] are moving from demos to production. Enterprises need governance, reliability, and cost control to deploy them safely. Redpanda Agentic Data Plane (ADP) combines a streaming-native immutable log, 300+ proven data connectors, and declarative AI agents into a unified platform with built-in compliance-grade audit trails.
1111

1212
After reading this page, you will be able to:
1313

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,11 @@ After reading this page, you will be able to:
1818
1919
== What is an AI agent?
2020

21-
An AI agent is a system built around a glossterm:large language model (LLM)[] that interprets user intent, selects the right tools, and chains multiple steps into a workflow. In Redpanda Cloud, agents are declarative: you configure what the agent should do (its role, constraints, and available tools) rather than writing imperative agent code. This is possible because Redpanda Connect provides 300+ connectors and robust data processing capabilities that the framework orchestrates for you.
21+
An AI agent is a system built around a glossterm:large language model (LLM)[] that interprets user intent, selects the right tools, and chains multiple steps into a workflow. In Redpanda Cloud, agents are declarative: you configure what the agent should do (its role, constraints, and available tools) rather than writing imperative agent code. This is possible because Redpanda Connect provides the connectors and robust data processing capabilities that the framework orchestrates for you.
2222

2323
== How agents work
2424

25-
When you create an agent, you configure these four components through the Redpanda Cloud Console rather than writing code:
25+
When you create an agent, you configure the components through the Redpanda Cloud Console rather than writing code:
2626

2727
* *System prompt*: Defines the agent's role, responsibilities, and constraints
2828
* *LLM*: Interprets user intent and decides which tools to invoke

modules/ai-agents/pages/ai-gateway/builders/discover-gateways.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Click the Configuration, API, MCP Tools, and Changelog tabs for additional infor
3434
3535
Using the API::
3636
+
37-
You can also list gateways programmatically:
37+
To list gateways programmatically:
3838
+
3939
[source,bash]
4040
----

modules/ai-agents/pages/ai-gateway/gateway-architecture.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@
88

99
include::ai-agents:partial$ai-gateway-byoc-note.adoc[]
1010

11-
This page provides technical details about AI Gateway's architecture, request processing, and capabilities. For an introduction to AI Gateway and the problems it solves, see xref:ai-agents:ai-gateway/what-is-ai-gateway.adoc[]
11+
This page provides technical details about AI Gateway's architecture, request processing, and capabilities. For an overview of AI Gateway, see xref:ai-agents:ai-gateway/what-is-ai-gateway.adoc[]
1212

1313
== Architecture overview
1414

15-
AI Gateway consists of three planes: a glossterm:control plane[] for configuration and management, a glossterm:data plane[] for request processing and routing, and an observability plane for monitoring and analytics.
15+
AI Gateway consists of a glossterm:control plane[] for configuration and management, a glossterm:data plane[] for request processing and routing, and an observability plane for monitoring and analytics.
1616

1717
// PLACEHOLDER: Add architecture diagram showing:
1818
// 1. Control Plane:
@@ -38,7 +38,7 @@ AI Gateway consists of three planes: a glossterm:control plane[] for configurati
3838
The control plane manages gateway configuration and policy definition:
3939

4040
* **Workspace management**: Multi-tenant isolation with separate namespaces for different teams or environments
41-
* **Provider configuration**: Enable and configure LLM providers (OpenAI, Anthropic, etc.)
41+
* **Provider configuration**: Enable and configure LLM providers (such as OpenAI and Anthropic)
4242
* **Gateway creation**: Define gateways with specific routing rules, budgets, and rate limits
4343
* **Policy definition**: Create CEL-based routing policies, spend limits, and rate limits
4444
* **MCP server registration**: Configure which MCP servers are available to agents
@@ -51,7 +51,7 @@ The data plane handles all runtime request processing:
5151
* **Authentication**: Validate API keys and gateway access
5252
* **Policy evaluation**: Apply rate limits, spend limits, and routing policies
5353
* **Provider pool management**: Select primary or fallback providers based on availability
54-
* **MCP aggregation**: Aggregate tools from multiple MCP servers with deferred loading
54+
* **MCP proxy**: Aggregate tools from multiple MCP servers with deferred loading
5555
* **Response transformation**: Normalize provider-specific responses to OpenAI format
5656
* **Metrics collection**: Record token usage, latency, and cost for every request
5757

@@ -143,7 +143,7 @@ In AI Hub mode, resources are divided into two categories:
143143
* Failover logic
144144
* Provider selection algorithms
145145

146-
*User-Configurable Resources:*
146+
*User-configurable resources:*
147147

148148
* Provider credentials (OpenAI, Anthropic, Google Gemini)
149149
* 6 preference toggles

modules/ai-agents/pages/ai-gateway/gateway-quickstart.adoc

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
= AI Gateway Quickstart
22
:description: Get started with AI Gateway. Configure providers, create your first gateway with failover and budget controls, and route your first request.
33
:page-topic-type: quickstart
4-
:personas: app_developer, platform_admin
4+
:personas: evaluator, app_developer, platform_admin
55
:learning-objective-1: Enable an LLM provider and create your first gateway
66
:learning-objective-2: Route your first request through AI Gateway and verify it works
77
:learning-objective-3: Verify request routing and token usage in the gateway overview
@@ -61,7 +61,7 @@ ifdef::ai-hub-available[]
6161
====
6262
When creating a gateway, you choose between two modes:
6363
64-
* *AI Hub Mode*: Zero-configuration with pre-configured routing and backend pools. Just add provider credentials and start routing requests. Ideal for quick starts and standard use cases.
64+
* *AI Hub Mode*: Zero-configuration with pre-configured routing and backend pools. Just add provider credentials and start routing requests. Ideal for quickstarts and standard use cases.
6565
* *Custom Mode*: Full control over all routing rules, backend pools, and policies. Requires manual configuration. Ideal for custom routing logic and specialized requirements.
6666
6767
See xref:ai-gateway/gateway-modes.adoc[] to understand which mode fits your needs. This quickstart focuses on Custom mode configuration.
@@ -273,9 +273,9 @@ The gateway provides these built-in MCP tools:
273273
* *Data catalog API*: Query your data catalog
274274
* *Memory store*: Persistent storage for agent state
275275
* *Vector search*: Semantic search over embeddings
276-
* *MCP orchestrator*: Built-in tool for programmatic multi-tool workflows
276+
* *MCP Orchestrator*: Built-in tool for programmatic multi-tool workflows
277277

278-
The *MCP orchestrator* enables agents to generate JavaScript code that calls multiple tools in a single orchestrated step, reducing round trips. For example, a workflow requiring 47 file reads can be reduced from 49 round trips to just 1.
278+
The *MCP Orchestrator* enables agents to generate JavaScript code that calls multiple tools in a single orchestrated step, reducing round trips. For example, a workflow requiring 47 file reads can be reduced from 49 round trips to just 1.
279279

280280
To add external tools (for example, Slack, GitHub), add their MCP server endpoints to your gateway configuration.
281281

@@ -284,14 +284,10 @@ To add external tools (for example, Slack, GitHub), add their MCP server endpoin
284284
When many tools are aggregated, listing all tools upfront can consume significant tokens. With deferred tool loading, the MCP gateway initially returns only:
285285

286286
* A tool search capability
287-
* The MCP orchestrator
287+
* The MCP Orchestrator
288288

289289
Agents then search for specific tools they need, retrieving only that subset. This can reduce token usage by 80-90% when you have many tools configured.
290290

291-
// REVIEWERS: When/how exactly do you use the orchestrator? Also what happens after they create a gateway? Please provide an example of how to validate end-to-end routing against the gateway endpoint!
292-
293-
// REVIEWERS: How do users connect to the ADP catalog + MCP servers exposed through RPCN?
294-
295291
== Configure CEL routing rule (optional)
296292

297293
Use CEL (Common Expression Language) expressions to route requests dynamically based on headers, content, or other request properties.

modules/ai-agents/pages/ai-gateway/mcp-aggregation-guide.adoc

Lines changed: 20 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,14 @@ The MCP Gateway provides glossterm:MCP[,Model Context Protocol (MCP)] aggregatio
1313
MCP Gateway benefits:
1414

1515
* Single endpoint: One MCP endpoint aggregates all approved MCP servers
16-
* Token reduction: Often 80-90% fewer tokens through deferred tool loading (depending on configuration)
16+
* Token reduction: Fewer tokens through deferred tool loading (depending on configuration)
1717
* Centralized governance: Admin-approved MCP servers only
1818
* Orchestration: JavaScript-based orchestrator reduces multi-step round trips
1919
* Security: Controlled tool execution environment
2020
2121
== What is MCP?
2222

23-
glossterm:MCP[,Model Context Protocol (MCP)] is a standard for exposing tools (functions) that AI agents can discover and invoke. MCP servers provide tools like:
23+
Model Context Protocol (MCP) is a standard for exposing tools (functions) that AI agents can discover and invoke. MCP servers provide tools like:
2424

2525
* Database queries
2626
* File system operations
@@ -58,14 +58,14 @@ glossterm:MCP[,Model Context Protocol (MCP)] is a standard for exposing tools (f
5858
│ (Claude, GPT) │
5959
└────────┬────────┘
6060
61-
│ 1. Discover tools via /mcp endpoint
61+
│ 1. Discover tools with /mcp endpoint
6262
│ 2. Invoke specific tool
6363
6464
┌────────▼────────────────────────────────┐
6565
│ AI Gateway (MCP Aggregator) │
6666
│ │
6767
│ ┌─────────────────────────────────┐ │
68-
│ │ Deferred Tool Loading │ │
68+
│ │ Deferred tool loading │ │
6969
│ │ (Send search + orchestrator │ │
7070
│ │ initially, defer others) │ │
7171
│ └─────────────────────────────────┘ │
@@ -249,8 +249,8 @@ Agent receives result and can continue reasoning.
249249
Traditional MCP (No deferred loading):
250250

251251
1. Agent connects to MCP endpoint
252-
2. Gateway sends ALL tools from ALL MCP servers (50+ tools)
253-
3. Agent includes ALL tool definitions in EVERY LLM request
252+
2. Gateway sends all tools from all MCP servers (50+ tools)
253+
3. Agent includes all tool definitions in every LLM request
254254
4. High token cost: ~5,000-10,000 tokens per request
255255

256256
Deferred loading (AI Gateway):
@@ -259,11 +259,10 @@ Deferred loading (AI Gateway):
259259
2. Gateway sends only 2 tools: `search_tools` + `orchestrator`
260260
3. Agent includes only 2 tool definitions in LLM request (~500-1,000 tokens)
261261
4. When agent needs specific tool:
262-
* Agent calls `search_tools` with query (e.g., "database")
262+
* Agent calls `search_tools` with query (for example, "database")
263263
* Gateway returns matching tools
264-
* Agent calls specific tool (e.g., `execute_sql`)
264+
* Agent calls specific tool (for example, `execute_sql`)
265265
5. Total token cost: Initial 500-1,000 + per-query ~200-500
266-
* Often 80-90% lower than loading all tools
267266

268267
=== When to use deferred loading
269268

@@ -282,7 +281,7 @@ Don't use deferred loading when:
282281

283282
=== Configure deferred loading
284283

285-
Deferred loading is configured per MCP server through the *Defer Loading Override* setting in the Create MCP Server dialog.
284+
Deferred loading is configured for each MCP server through the *Defer Loading Override* setting in the Create MCP Server dialog.
286285

287286
. Navigate to your gateway's *MCP* tab.
288287
. Create or edit an MCP server.
@@ -328,7 +327,7 @@ Compare token usage before/after deferred loading:
328327
Savings % = ((Before - After) / Before) × 100
329328
----
330329

331-
Expected Results: Typically 80-90% reduction in average tokens per request
330+
Expected results: Typically 80-90% reduction in average tokens per request
332331

333332
== Orchestrator: multi-step workflows
334333

@@ -342,7 +341,7 @@ Without Orchestrator:
342341
2. Agent receives results, evaluates: "Results insufficient"
343342
3. Agent: "Fallback to web search" → Round trip 2
344343
4. Agent receives results, processes → Round trip 3
345-
5. *Total: 3 round trips* (high latency, token cost)
344+
5. *Total: 3 round trips* (high latency, 3x token cost)
346345

347346
With Orchestrator:
348347

@@ -594,9 +593,9 @@ Common MCP servers:
594593

595594
* Database: PostgreSQL, MySQL, MongoDB query tools
596595
* Filesystem: Read/write/search files
597-
* API Integrations: Slack, GitHub, Salesforce, Stripe
598-
* Search: Web search, vector search, enterprise search
599-
* Code Execution: Python, JavaScript sandboxes
596+
* API integrations: Slack, GitHub, Salesforce, Stripe
597+
* Search: web search, vector search, enterprise search
598+
* Code execution: Python, JavaScript sandboxes
600599
* Workflow: Zapier, n8n integrations
601600

602601
=== MCP server approval workflow
@@ -759,7 +758,7 @@ Possible causes:
759758

760759
Solution:
761760

762-
1. Verify MCP server is active in the Cloud console
761+
1. Verify MCP server is active in the Redpanda Cloud console
763762
2. Verify tool is in enabled_tools list
764763
3. If deferred loading: Agent must call `search_tools` first
765764

@@ -768,13 +767,13 @@ Issue: "MCP server timeout"
768767
Possible causes:
769768

770769
1. MCP server is down/unreachable
771-
2. Tool execution is slow (e.g., expensive database query)
770+
2. Tool execution is slow (for example, expensive database query)
772771
3. Gateway timeout too short
773772

774773
Solution:
775774

776775
1. Check MCP server health
777-
2. Optimize tool (e.g., add database index)
776+
2. Optimize tool (for example, add database index)
778777
3. Contact support if you need to adjust timeout limits
779778

780779
Issue: "Orchestrator workflow failed"
@@ -805,8 +804,8 @@ Orchestrator sandbox:
805804
* No file system access
806805
* No network access (except via MCP tools)
807806
* No system calls
808-
* Memory limit: // PLACEHOLDER: e.g., 128MB
809-
* Execution timeout: // PLACEHOLDER: e.g., 30s
807+
* Memory limit: // PLACEHOLDER: for example, 128MB
808+
* Execution timeout: // PLACEHOLDER: for example, 30s
810809
811810
MCP tool execution:
812811
@@ -856,7 +855,7 @@ Best practice:
856855

857856
* Read-only tools in production gateway
858857
* Write tools only in staging gateway (with approval workflows)
859-
* Wrap dangerous operations in MCP server with safeguards (e.g., "require confirmation token")
858+
* Wrap dangerous operations in MCP server with safeguards (for example, "require confirmation token")
860859

861860
== MCP + LLM routing
862861

0 commit comments

Comments
 (0)