Skip to content

Commit 344ee08

Browse files
JakeSCahillclaude
andcommitted
Remove sessions and tasks topics from agent documentation
Sessions and tasks topics are being soft-hidden with __ prefix as they are internal implementation details. Updated documentation to focus on user-facing monitoring features (transcripts and inspector). Changes: - Remove "Agent data topics" section from concepts.adoc with schemas - Remove "Consume agent data topics" section from monitor-agents.adoc - Update troubleshooting.adoc to reference transcripts instead of topics - Update learning objective to "Track token usage and performance metrics" - Fix xref anchor links to include descriptive text - Fix shipping carrier name to comply with Google style guide Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
1 parent 0a840a0 commit 344ee08

27 files changed

Lines changed: 558 additions & 463 deletions

modules/ai-agents/examples/mcp-tools/processors/get_shipping_info.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ processors:
77
{
88
"order_id": $order_id,
99
"tracking_number": "FX1234567890",
10-
"carrier": "FedEx",
10+
"carrier": "Example Shipping",
1111
"status": "in_transit",
1212
"estimated_delivery": "2025-01-17",
1313
"last_location": "San Francisco Distribution Center",

modules/ai-agents/examples/mcp-tools/processors/order_workflow.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ processors:
3939
root = this.merge({
4040
"processing_tier": "premium",
4141
"processing_time_estimate": "2-4 hours",
42-
"assigned_rep": "premium-team@company.com",
42+
"assigned_rep": "premium-team@example.com",
4343
"priority_score": 95
4444
})
4545
@@ -51,7 +51,7 @@ processors:
5151
root = this.merge({
5252
"processing_tier": "vip",
5353
"processing_time_estimate": "1-2 hours",
54-
"assigned_rep": "vip-team@company.com",
54+
"assigned_rep": "vip-team@example.com",
5555
"priority_score": 90,
5656
"perks": ["expedited_shipping", "white_glove_service"]
5757
})
@@ -63,7 +63,7 @@ processors:
6363
root = this.merge({
6464
"processing_tier": "standard",
6565
"processing_time_estimate": "24-48 hours",
66-
"assigned_rep": "support@company.com",
66+
"assigned_rep": "support@example.com",
6767
"priority_score": 50
6868
})
6969

modules/ai-agents/pages/agents/a2a-concepts.adoc

Lines changed: 16 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,10 @@ Agents that implement A2A expose their capabilities through a standardized agent
2323

2424
The protocol provides:
2525

26-
* **Standardized discovery:** Agent cards describe capabilities in a machine-readable format.
27-
* **Platform independence:** Any system can call any A2A-compliant agent.
28-
* **Version negotiation:** Protocol versions ensure compatibility between agents.
29-
* **Communication mode flexibility:** Supports synchronous request/response and streaming.
26+
* Standardized discovery: Agent cards describe capabilities in a machine-readable format.
27+
* Platform independence: Any system can call any A2A-compliant agent.
28+
* Version negotiation: Protocol versions ensure compatibility between agents.
29+
* Communication mode flexibility: Supports synchronous request/response and streaming.
3030

3131
For the complete specification, see link:https://a2a.ag/spec[a2a.ag/spec^].
3232

@@ -49,10 +49,10 @@ The `.well-known` path follows internet standards for service discovery, making
4949

5050
An agent card describes:
5151

52-
* **Agent capabilities:** Skills and tools the agent provides.
53-
* **Input/output formats:** Expected request and response structures.
54-
* **Protocol version:** A2A specification version the agent supports.
55-
* **Communication modes:** Whether the agent supports synchronous calls, streaming, or both.
52+
* Agent capabilities: Skills and tools the agent provides.
53+
* Input/output formats: Expected request and response structures.
54+
* Protocol version: A2A specification version the agent supports.
55+
* Communication modes: Whether the agent supports synchronous calls, streaming, or both.
5656

5757
Example agent card structure:
5858

@@ -89,19 +89,13 @@ For integration pattern guidance, see xref:ai-agents:agents/integration-overview
8989

9090
=== Internal pipeline-to-agent integration
9191

92-
Redpanda Connect pipelines use the xref:develop:connect/components/processors/a2a_message.adoc[`a2a_message`] processor to invoke agents for each event in a stream:
93-
94-
----
95-
Redpanda Connect Pipeline sends events to a2a_message (A2A) which invokes Redpanda Cloud Agent
96-
----
97-
98-
Use cases:
92+
Redpanda Connect pipelines use the xref:develop:connect/components/processors/a2a_message.adoc[`a2a_message`] processor to invoke agents for each event in a stream. This enables real-time interaction between streaming data and AI agents, enabling use cases like:
9993

10094
* Real-time fraud detection on every transaction.
10195
* Streaming data enrichment with AI-generated fields.
10296
* Event-driven agent invocation for automated processing.
10397

104-
The xref:develop:connect/components/processors/a2a_message.adoc[`a2a_message`] processor uses A2A protocol internally to discover and call agents. For pipeline patterns, see xref:ai-agents:agents/pipeline-integration-patterns.adoc[].
98+
The `a2a_message` processor uses the A2A protocol internally to discover and call agents. For pipeline patterns, see xref:ai-agents:agents/pipeline-integration-patterns.adoc[].
10599

106100
== How agents discover each other
107101

@@ -133,9 +127,9 @@ External callers use these credentials to obtain access tokens:
133127

134128
This flow ensures:
135129

136-
* **Credentials stay secure:** Applications never send them directly to agents, only access tokens.
137-
* **Exposure is limited:** Tokens expire, reducing the window for compromised credentials.
138-
* **Integration is standard:** Applications can use existing OAuth2 libraries.
130+
* Credentials stay secure: Applications never send them directly to agents, only access tokens.
131+
* Exposure is limited: Tokens expire, reducing the window for compromised credentials.
132+
* Integration is standard: Applications can use existing OAuth2 libraries.
139133

140134
=== External integration
141135

@@ -153,6 +147,6 @@ The A2A protocol uses semantic versioning (major.minor.patch). Agents declare th
153147

154148
== Next steps
155149

156-
* xref:ai-agents:agents/integration-overview.adoc[]: Choose the right integration pattern for your use case
157-
* xref:ai-agents:agents/create-agent.adoc[]: Create an agent that exposes an A2A agent card
158-
* link:https://a2a.ag/spec[A2A Protocol Specification^]: Complete technical reference
150+
* xref:ai-agents:agents/integration-overview.adoc[]
151+
* xref:ai-agents:agents/create-agent.adoc[]
152+
* link:https://a2a.ag/spec[A2A Protocol Specification^]

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

Lines changed: 6 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -18,14 +18,10 @@ After reading this page, you will be able to:
1818

1919
Agent architecture determines how you manage complexity as your system grows. The right pattern depends on your domain complexity, organizational structure, and how you expect requirements to evolve.
2020

21-
=== When simple agents become unmaintainable
22-
23-
Single agents work well initially but break down as complexity grows.
21+
Starting with a simple architecture is tempting, but can lead to unmaintainable systems as complexity increases. Planning for growth with clear boundaries prevents technical debt and costly refactoring later.
2422

2523
Warning signs include system prompts exceeding 2000 words, too many tools for the LLM to select correctly, multiple teams modifying the same agent, and changes in one domain breaking others. These symptoms indicate you need architectural boundaries, not just better prompts.
2624

27-
=== Domain complexity drives architecture
28-
2925
Match agent architecture to domain structure:
3026

3127
[cols="2,3,3"]
@@ -45,7 +41,6 @@ Match agent architecture to domain structure:
4541
| Organizational boundaries require system boundaries
4642
|===
4743

48-
=== Trade-offs
4944

5045
Every architecture pattern involves trade-offs.
5146

@@ -131,33 +126,6 @@ External A2A lets different teams own and deploy their agents independently, wit
131126

132127
External A2A adds network latency on every cross-agent call, and authentication complexity multiplies with each agent requiring credential management. Removing capabilities or changing contracts requires coordination across consuming systems, and debugging requires tracing requests across organizational boundaries.
133128

134-
=== Choosing between patterns
135-
136-
[cols="1,2,2"]
137-
|===
138-
| Use Case | Internal Subagents | External A2A
139-
140-
| Domain separation within one team
141-
| Recommended
142-
| Unnecessary complexity
143-
144-
| Cross-organization workflows
145-
| Not possible
146-
| Required
147-
148-
| Shared infrastructure acceptable
149-
| Simpler
150-
| Use external if independence needed
151-
152-
| Different deployment requirements
153-
| Limited (same cluster)
154-
| Full flexibility
155-
156-
| Real-time performance critical
157-
| Lower latency
158-
| Higher latency
159-
|===
160-
161129
For implementation details on external A2A integration, see xref:ai-agents:agents/integration-overview.adoc[].
162130

163131
== Common anti-patterns
@@ -252,31 +220,10 @@ Use retry logic for transient failures like network timeouts. Report permanent f
252220

253221
Provide clear error messages to users. Log errors for debugging.
254222

255-
== Summary
256-
257-
Choose architecture patterns based on domain complexity and organizational needs:
258-
259-
[cols="1,2,2"]
260-
|===
261-
| Pattern | Use When | Trade-off
262-
263-
| Single agent
264-
| Narrow domain, single organization
265-
| Limited scalability
266-
267-
| Internal subagents
268-
| Complex domains, shared infrastructure
269-
| Higher operational complexity
270-
271-
| External A2A
272-
| Multi-organization, independent systems
273-
| Network latency, coordination overhead
274-
|===
275-
276223
== Next steps
277224

278-
* xref:ai-agents:agents/integration-overview.adoc[]: Choose between agents invoking tools and pipelines calling agents
279-
* xref:ai-agents:agents/a2a-concepts.adoc[]: Learn how the A2A protocol enables agent communication
280-
* xref:ai-agents:mcp/remote/tool-patterns.adoc[]: Explore tool design patterns
281-
* xref:ai-agents:agents/overview.adoc[]: Review agent components
282-
* xref:ai-agents:mcp/remote/best-practices.adoc[]: Learn MCP tool best practices
225+
* xref:ai-agents:agents/integration-overview.adoc[]
226+
* xref:ai-agents:agents/a2a-concepts.adoc[]
227+
* xref:ai-agents:mcp/remote/tool-patterns.adoc[]
228+
* xref:ai-agents:agents/overview.adoc[]
229+
* xref:ai-agents:mcp/remote/best-practices.adoc[]

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

Lines changed: 5 additions & 114 deletions
Original file line numberDiff line numberDiff line change
@@ -133,8 +133,6 @@ The agent's context includes the system prompt (always present), user messages,
133133

134134
Agents persist conversation context within a session. When you use the *Inspector* tab in the Redpanda Cloud Console, it automatically maintains session state across multiple requests. For programmatic access, applications must pass a session ID to maintain conversation continuity across requests.
135135

136-
All conversation data is stored in the agent's sessions topic. For details on accessing conversation history, see <<agent-data-topics>>.
137-
138136
=== Context window limits
139137

140138
LLM context windows limit how much history fits. Small models support 8K-32K tokens, medium models support 32K-128K tokens, and large models support 128K-1M+ tokens.
@@ -145,120 +143,13 @@ Design workflows to complete within context limits. Avoid unbounded tool chainin
145143

146144
=== State across conversations
147145

148-
Redpanda Cloud automatically persists conversation history and task execution data to agent-specific topics:
149-
150-
* *Sessions topic* (`redpanda.aiagent.<agent-id>.sessions`): Stores all conversation messages and history
151-
* *Tasks topic* (`redpanda.aiagent.<agent-id>.tasks`): Stores task execution records with status and artifacts
152-
153-
The *Inspector* tab automatically manages sessions for you. For programmatic integration, pass a session ID in API requests to maintain conversation continuity.
154-
155-
You can consume from these topics to:
156-
157-
* Review past conversations and agent responses
158-
* Analyze conversation patterns and common requests
159-
* Debug agent behavior by examining full conversation history
160-
* Build conversation analytics and monitoring dashboards
161-
* Implement custom conversation management in your application
162-
163-
For complete details on topic schemas and usage, see <<agent-data-topics>>.
146+
Redpanda Cloud automatically persists conversation history. The *Inspector* tab automatically manages sessions for you. For programmatic integration, pass a session ID in API requests to maintain conversation continuity.
164147

165148
If you need additional state management beyond conversation history, create tools that read/write to custom state stores, or pass relevant context in each request.
166149

167-
[[agent-data-topics]]
168-
== Agent data topics
169-
170-
Each agent automatically creates two topics for storing session and task data:
171-
172-
* `redpanda.aiagent.<agent-id>.sessions`: Conversation history and session state
173-
* `redpanda.aiagent.<agent-id>.tasks`: Task execution records with status and artifacts
174-
175-
Two schemas are also registered: `redpanda-session-value` and `redpanda-a2a-task-value`.
176-
177-
Redpanda uses these topics internally to persist conversation history and reload context when sessions resume. This allows agents to maintain continuity across interactions.
178-
179-
These topics and schemas are managed automatically by Redpanda. If you delete either a topic or schema, they are recreated automatically. However, deleting a topic permanently deletes all stored data (including conversation history), and the topic comes back empty. Do not produce your own data to these topics. They are reserved for agent data.
180-
181-
For guidance on consuming these topics, analyzing conversation history, and monitoring agent performance, see xref:ai-agents:agents/monitor-agents.adoc[].
182-
183-
=== Sessions topic
184-
185-
The sessions topic stores conversation data, including all messages exchanged between users and the agent:
186-
187-
[source,json]
188-
----
189-
{
190-
"id": "agent-chat-abc123-WqyUmxv0fuACoSE69MCx4",
191-
"messages": [
192-
{
193-
"role": "MESSAGE_ROLE_USER",
194-
"content": [
195-
{
196-
"kind": "PART_KIND_TEXT",
197-
"text": "What's the weather in Seattle?"
198-
}
199-
]
200-
},
201-
{
202-
"role": "MESSAGE_ROLE_ASSISTANT",
203-
"content": [
204-
{
205-
"kind": "PART_KIND_TEXT",
206-
"text": "The current weather in Seattle is 52°F with light rain."
207-
}
208-
]
209-
}
210-
],
211-
"metadata": {}
212-
}
213-
----
214-
215-
Use session data for debugging conversation flow, auditing agent interactions, and building conversation analytics.
216-
217-
=== Tasks topic
218-
219-
The tasks topic stores execution records for each agent task, including status, artifacts, message history, and token usage:
220-
221-
[source,json]
222-
----
223-
{
224-
"id": "019bc2d5-13e0-785b-9ff4-a218708e52bc",
225-
"contextId": "agent-chat-abc123-oGoqyBCeH5RHTsit8qpRi",
226-
"status": {
227-
"state": "TASK_STATE_COMPLETED",
228-
"timestamp": "2026-01-15T18:05:03.993157355Z"
229-
},
230-
"artifacts": [
231-
{
232-
"artifactId": "019bc2d5-186a-76c7-97d1-feb13c75a2d4",
233-
"parts": [
234-
{
235-
"text": "The current weather in Seattle is 52°F with light rain."
236-
}
237-
]
238-
}
239-
],
240-
"history": [...],
241-
"metadata": {
242-
"usage": {
243-
"input_tokens": 64,
244-
"output_tokens": 9,
245-
"total_tokens": 130
246-
}
247-
}
248-
}
249-
----
250-
251-
Task states include:
252-
253-
* `TASK_STATE_COMPLETED`: Task finished successfully
254-
* `TASK_STATE_FAILED`: Task encountered an error
255-
* `TASK_STATE_RUNNING`: Task is in progress
256-
257-
Use task data for monitoring task completion rates, tracking token usage and costs, debugging failed tasks, and building operational dashboards.
258-
259150
== Next steps
260151

261-
* xref:ai-agents:agents/architecture-patterns.adoc[]: Apply these concepts to design patterns
262-
* xref:ai-agents:agents/quickstart.adoc[]: See execution concepts in action
263-
* xref:ai-agents:agents/prompt-best-practices.adoc[]: Write prompts that guide agent reasoning
264-
* xref:ai-agents:mcp/remote/best-practices.adoc[]: Design tools that work well with agent execution
152+
* xref:ai-agents:agents/architecture-patterns.adoc[]
153+
* xref:ai-agents:agents/quickstart.adoc[]
154+
* xref:ai-agents:agents/prompt-best-practices.adoc[]
155+
* xref:ai-agents:mcp/remote/best-practices.adoc[]

0 commit comments

Comments
 (0)