Skip to content

Commit 9b9d216

Browse files
committed
Address feedback
1 parent 6ca2e6d commit 9b9d216

8 files changed

Lines changed: 17 additions & 17 deletions

File tree

modules/ai-agents/examples/agents/dispute-root-agent-prompt.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,12 +61,12 @@ Never:
6161
**Clear, bank-appropriate language:**
6262
- Use "I've reviewed your account" not "I called the account-agent"
6363
- Use "this charge doesn't match your typical spending" not "fraud score is 95/100"
64-
- Use "I'm blocking this card" not "I recommend you freeze it"
64+
- Use "We're blocking this card" not "I recommend you freeze it"
6565
- Don't reveal merchant reputation scores or fraud report counts
6666

6767
**Proactive protection:**
6868
For likely fraud (score 80+):
69-
- Block the card immediately: "I'm blocking your card ending in [XXXX] right now to prevent additional fraudulent charges"
69+
- Block the card immediately: "We're blocking your card ending in [XXXX] right now to prevent additional fraudulent charges"
7070
- Issue replacement: "We'll send you a replacement card with a new number"
7171
- Process the claim: "You'll see the credit for this charge within 10 business days"
7272

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
:learning-objective-2: Choose appropriate LLM models based on task requirements
77
:learning-objective-3: Apply agent boundary design principles for maintainability
88

9-
Design agent systems that are maintainable, discoverable, and reliable by choosing the right architecture pattern and applying clear boundary principles.
9+
This topic helps you design agent systems that are maintainable, discoverable, and reliable by choosing the right architecture pattern and applying clear boundary principles.
1010

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

@@ -140,7 +140,7 @@ For implementation details on external A2A integration, see xref:ai-agents:agent
140140

141141
== Common anti-patterns
142142

143-
Avoid these architecture mistakes that lead to unmaintainable agent systems.
143+
Avoid these architecture mistakes that lead to unmaintainable agent systems. For examples of well-structured agents, see the xref:ai-agents:agents/tutorials/customer-support-agent.adoc[multi-tool orchestration tutorial] and xref:ai-agents:agents/tutorials/transaction-dispute-resolution.adoc[multi-agent architecture tutorial].
144144

145145
=== The monolithic prompt
146146

@@ -212,7 +212,7 @@ For complex reasoning, choose premium models such as Claude Opus 4.5 or GPT-5.2.
212212

213213
For real-time responses, choose smaller models. Use models optimized for speed, such as Mini or base tiers.
214214

215-
For batch processing, optimize for accuracy over speed. Use larger models when users don't wait for results.
215+
For batch processing, optimize for accuracy over speed. Use larger models when users aren't waiting for results.
216216

217217
=== Optimize for cost and volume
218218

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ When integrating external applications with Redpanda Cloud agents, protect crede
115115

116116
=== Protect service account credentials
117117

118-
Store the client ID and secret in secure credential stores, not in code. Use environment variables or secrets management systems. Rotate credentials if compromised and restrict access based on the principle of least privilege.
118+
Store the client ID and secret in secure credential stores, not in code. Use environment variables or xref:security:secrets.adoc[secrets management]. Rotate credentials if compromised and restrict access based on the principle of least privilege.
119119

120120
=== Protect access tokens
121121

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ The *Inspector* tab provides real-time conversation testing. Use it to test agen
8888

8989
=== Testing best practices
9090

91-
Test your agents systematically by exploring edge cases and potential failure scenarios. Begin with boundary testing. Requests at the edge of agent capabilities verify that scope enforcement works correctly. Error handling becomes clear when you request unavailable data and observe whether the agent degrades gracefully or fabricates information.
91+
Test your agents systematically by exploring edge cases and potential failure scenarios. Begin with boundary testing. Requests at the edge of agent capabilities verify that scope enforcement works correctly. Error handling becomes clear when you request unavailable data and observe whether the agent degrades gracefully. Even with proper system prompt constraints, testing confirms that your agent responds appropriately to edge cases.
9292

9393
Monitor iteration counts during complex requests to ensure they complete within your configured limits. Ambiguous or vague queries reveal whether the agent asks clarifying questions or makes risky assumptions. Throughout testing, track token usage per request to estimate costs and identify which query patterns consume the most resources.
9494

modules/ai-agents/pages/agents/tutorials/customer-support-agent.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ After completing this tutorial, you will be able to:
1616
* [ ] {learning-objective-2}
1717
* [ ] {learning-objective-3}
1818
19-
== What you'll learn
19+
== Why multi-tool orchestration matters
2020

2121
Agents become powerful when they coordinate multiple tools to solve complex problems. A single-tool agent can retrieve order status. A multi-tool agent can check order status, fetch tracking information, look up customer history, and decide which tools to invoke based on conversation context.
2222

modules/ai-agents/pages/agents/tutorials/transaction-dispute-resolution.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -613,7 +613,7 @@ The pipeline uses a two-stage filter:
613613
- Only processes transactions with `amount > 500` or `preliminary_flag == true`
614614
- Only sends transactions to the agent if `preliminary_risk_score >= 40`
615615

616-
Transactions that pass the first filter but not the second (e.g., a $600 domestic transaction with low risk) will appear in the output with:
616+
Transactions that pass the first filter but not the second (for example, a $600 domestic transaction with low risk) will appear in the output with:
617617

618618
* `final_decision: "low_risk_no_investigation"`
619619
* `alert_level: "low"`

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -110,15 +110,15 @@ MCP server traces contain these span types:
110110
| Internal service processing span that appears at multiple levels in the hierarchy. Represents Redpanda Connect service operations including routing, processing, and component execution.
111111
| Track internal processing overhead and identify where time is spent in the service layer.
112112

113-
| Tool name (e.g., `get_order_status`, `get_customer_history`)
113+
| Tool name (for example, `get_order_status`, `get_customer_history`)
114114
| The specific MCP tool being invoked. This span name matches the tool name defined in the MCP server configuration.
115115
| Identify which tool was called and measure tool-specific execution time.
116116

117117
| `processors`
118118
| Processor pipeline execution span showing the collection of processors that process the tool's data. Appears as a child of the tool invocation span.
119119
| Measure total processor pipeline execution time.
120120

121-
| Processor name (e.g., `mapping`, `http`, `branch`)
121+
| Processor name (for example, `mapping`, `http`, `branch`)
122122
| Individual processor execution span representing a single Redpanda Connect processor. The span name matches the processor type.
123123
| Identify slow processors and debug processing logic.
124124
|===

modules/ai-agents/partials/transcripts-ui-guide.adoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434
=== Navigate the transcripts view
3535

3636
// Navigation is identical for both contexts
37-
. In the left navigation panel, click *Transcripts*.
37+
. Click *Transcripts*.
3838
ifeval::["{context}" == "agent"]
3939
. Select a recent transcript from your agent executions.
4040
endif::[]
@@ -44,14 +44,14 @@ endif::[]
4444

4545
The transcripts view displays:
4646

47-
* *Timeline* (top): Visual history of recent executions with success/error indicators
48-
* *Trace list* (middle): Hierarchical view of traces and spans
49-
* *Summary panel* (right): Detailed metrics when you select a transcript
47+
* *Timeline*: Visual history of recent executions with success/error indicators
48+
* *Trace list*: Hierarchical view of traces and spans
49+
* *Summary panel*: Detailed metrics when you select a transcript
5050

5151
// UI component descriptions
5252
==== Timeline visualization
5353

54-
The timeline at the top shows execution patterns over time:
54+
The timeline shows execution patterns over time:
5555

5656
* Green bars: Successful executions
5757
* Red bars: Failed executions with errors
@@ -74,7 +74,7 @@ endif::[]
7474

7575
==== Summary panel
7676

77-
When you select a transcript, the right panel shows:
77+
When you select a transcript, the summary panel shows:
7878

7979
* Duration: Total execution time for this request
8080
* Total Spans: Number of operations in the trace

0 commit comments

Comments
 (0)