Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
114 commits
Select commit Hold shift + click to select a range
021990a
DOC-1867 AI Gateway
micheleRP Jan 6, 2026
5a9cc4b
add questions for reviewers
micheleRP Jan 6, 2026
8188598
incorporate review comments
micheleRP Jan 6, 2026
c072cc0
configure AI Gateway LLM & MCP endpoints in Claude Code & similar tools
micheleRP Jan 6, 2026
1588b36
update Claude Code example + index page
micheleRP Jan 6, 2026
9c75742
revert nav title
micheleRP Jan 9, 2026
fce266b
edits
micheleRP Jan 11, 2026
85257c9
Add comprehensive AI Gateway documentation partials
micheleRP Jan 11, 2026
f2c87a3
clean up cc drafts
micheleRP Jan 12, 2026
f359f7b
cleanup
micheleRP Jan 12, 2026
8786f1a
cleanup
micheleRP Jan 12, 2026
49a573f
Apply documentation style guide to AI Gateway pages
micheleRP Jan 14, 2026
d3c6c23
Add AI Gateway client integration documentation
micheleRP Jan 15, 2026
07628a0
clean up
micheleRP Jan 16, 2026
70e3e23
docs: Add http_server and a2a_message connector pages
JakeSCahill Jan 20, 2026
2746f6b
cleanup overview and quickstarts
micheleRP Jan 20, 2026
5f5525d
Improve AI agents documentation readability and structure
JakeSCahill Jan 20, 2026
09a766a
Merge branch 'main' into ai-agents-documentation
JakeSCahill Jan 20, 2026
8f264a9
cc audit
micheleRP Jan 20, 2026
8b7bcf5
Improve customer support tutorial with explicit instructions
JakeSCahill Jan 21, 2026
a1b3207
Lowercase inspector when not writing about the UI button
JakeSCahill Jan 21, 2026
bbdabd8
Restructure observability docs for better information architecture
JakeSCahill Jan 21, 2026
83e3f02
Rename to Transcripts
JakeSCahill Jan 21, 2026
0a840a0
Merge branch 'main' into ai-agents-documentation
JakeSCahill Jan 21, 2026
77429a3
edit for user journey
micheleRP Jan 22, 2026
344ee08
Remove sessions and tasks topics from agent documentation
JakeSCahill Jan 22, 2026
01d61b5
update nav
micheleRP Jan 22, 2026
acbbde8
update nav
micheleRP Jan 22, 2026
13e403a
Merge branch 'main' into DOC-1867-Document-feature-AI-Gateway-help-cl…
micheleRP Jan 22, 2026
2ed4e2f
Merge branch 'main' into ai-agents-documentation
JakeSCahill Jan 23, 2026
492a50f
Refactor AI Gateway documentation for clarity and consistency
micheleRP Jan 23, 2026
02bb472
style edits
micheleRP Jan 23, 2026
21601b1
Convert learning objectives to standard format across all AI Gateway …
micheleRP Jan 23, 2026
84e5708
Fix persona metadata attribute to use correct standard
micheleRP Jan 23, 2026
2ab1f1c
Fix Anthropic model identifiers in gateway quickstart examples
micheleRP Jan 23, 2026
c1d3a5e
Clarify VS Code settings.json does not support native env var substit…
micheleRP Jan 23, 2026
ad4c882
Change Cursor MCP endpoint to use HTTPS instead of HTTP
micheleRP Jan 23, 2026
acc0c23
Fix inconsistent list markers in GitHub Copilot security section
micheleRP Jan 23, 2026
8742a94
Fix SDK examples in migration guide and remove placeholder notes
micheleRP Jan 24, 2026
6457cf4
Soften hard numeric claims with qualifiers across AI Gateway docs
micheleRP Jan 24, 2026
174199b
Convert persona restructuring plan from Markdown to AsciiDoc
micheleRP Jan 24, 2026
7621fdb
Remove unused ai-gateway.png image file
micheleRP Jan 24, 2026
273efa9
Remove persona restructuring planning document
micheleRP Jan 24, 2026
3de2abf
Update Claude Code config to match Anthropic MCP schema
micheleRP Jan 24, 2026
2d3c018
Add note about environment variable interpolation in mcpServers
micheleRP Jan 24, 2026
6c2b01c
Update Cline config to use official extension settings
micheleRP Jan 24, 2026
d73e572
Replace hardcoded token with env var in curl example
micheleRP Jan 24, 2026
1b32ae0
Update Continue.dev config to current YAML standard
micheleRP Jan 24, 2026
c34b122
Fix Continue.dev environment variable interpolation syntax
micheleRP Jan 24, 2026
48a108b
Fix Cursor settings.json environment variable handling
micheleRP Jan 24, 2026
56782ec
Fix GitHub Copilot configuration settings and flow
micheleRP Jan 24, 2026
a034c9c
Remove duplicate rp-aigw-id from LlamaIndex example
micheleRP Jan 24, 2026
930b261
Fix Continue.dev config file references to use YAML
micheleRP Jan 24, 2026
3a4d026
Fix Continue.dev MCP server schema in config.yaml examples
micheleRP Jan 24, 2026
d0fdb50
Fix unsupported ${VAR} interpolation in Continue.dev project config
micheleRP Jan 24, 2026
ac4d51d
Improve Continue.dev documentation clarity and compliance
micheleRP Jan 24, 2026
f754065
Remove checkboxes and periods from learning objectives across all int…
micheleRP Jan 24, 2026
8ce3de8
Revert "Remove checkboxes and periods from learning objectives across…
micheleRP Jan 24, 2026
44c4528
update nav
micheleRP Jan 24, 2026
6342ede
Doc UI and update terminology for transcripts
kbatuigas Jan 26, 2026
bd729fc
Add transcripts UI doc to nav
kbatuigas Jan 27, 2026
37ca83b
Add fraud agent tutorial
JakeSCahill Jan 27, 2026
548f01b
Merge branch 'main' into ai-agents-documentation
JakeSCahill Jan 27, 2026
4036ba9
Improve readability
JakeSCahill Jan 27, 2026
783d2ee
Update modules/ai-agents/examples/agents/fraud-agent-prompt.txt
JakeSCahill Jan 27, 2026
fae5d3c
Apply suggestions
JakeSCahill Jan 27, 2026
5c20723
Apply suggestions
JakeSCahill Jan 27, 2026
33ecc8b
update cloud overview adp focus
micheleRP Jan 27, 2026
89b9fa7
Update cloud overview with latest ADP content from CTO Tech Talk demo
micheleRP Jan 27, 2026
8668d63
cleanup
micheleRP Jan 27, 2026
cce5fb2
minor edits
micheleRP Jan 28, 2026
cc149b9
Apply suggestions from SME review
kbatuigas Jan 28, 2026
100b314
minor edit
micheleRP Jan 28, 2026
83ca90e
Merge branch 'DOC-1867-Document-feature-AI-Gateway-help-cloud-team-po…
paulohtb6 Jan 29, 2026
a72b6b8
Merge branch 'update-cloud-overview-adp-focus' into adp-pkg1
paulohtb6 Jan 29, 2026
68f517a
Merge branch 'DOC-1901-document-feature-adp-execution-logs-ui-package…
paulohtb6 Jan 29, 2026
6d22dba
fix nav
paulohtb6 Jan 29, 2026
a25425d
minor edit
micheleRP Jan 29, 2026
438319a
Merge branch 'update-cloud-overview-adp-focus' into adp-pkg1
paulohtb6 Jan 29, 2026
40c2bbb
Apply suggestion from @JakeSCahill
JakeSCahill Jan 29, 2026
1cf01c3
Fix example
JakeSCahill Jan 29, 2026
28a21e5
Fix code review feedback
JakeSCahill Jan 29, 2026
71b1d19
Apply suggestions
JakeSCahill Jan 29, 2026
ea9910a
Apply suggestions
JakeSCahill Jan 29, 2026
20ccc4c
AWS only & what's new blurb
micheleRP Jan 29, 2026
000b819
AWS only
micheleRP Jan 29, 2026
29a7123
Merge branch 'ai-agents-documentation' into adp-pkg1
paulohtb6 Jan 30, 2026
3d03530
Merge branch 'DOC-1867-Document-feature-AI-Gateway-help-cloud-team-po…
paulohtb6 Jan 30, 2026
5e94aca
Merge branch 'update-cloud-overview-adp-focus' into adp-pkg1
paulohtb6 Jan 30, 2026
6bae27f
Apply feedback
JakeSCahill Jan 30, 2026
35ce1a3
Update modules/ai-agents/pages/agents/overview.adoc
JakeSCahill Jan 30, 2026
72806fe
Remove alias
JakeSCahill Jan 30, 2026
3f5383e
Remove incorrectly added files from previous commit
JakeSCahill Jan 30, 2026
8f083fd
Integrate AI Gateway into agent documentation
JakeSCahill Feb 2, 2026
1e0d4c5
Update local-antora-playbook.yml
JakeSCahill Feb 2, 2026
722c228
Replace 'Cloud UI' with 'Cloud Console' throughout ai-agents docs
JakeSCahill Feb 2, 2026
6bac58b
Update MCP overview
JakeSCahill Feb 2, 2026
b5b404c
Remove search and add placeholder for filtering functionality
kbatuigas Feb 2, 2026
be98ee0
Clarify trace format
kbatuigas Feb 2, 2026
9771301
Start telemetry doc for BYOA
kbatuigas Jan 27, 2026
9592dcb
Add byoa telemetry to nav tree
kbatuigas Feb 2, 2026
f59d7a9
Merge branch 'ai-agents-documentation' into adp-pkg1
paulohtb6 Feb 3, 2026
ca6f6dc
conditionalize out content not for package 1
micheleRP Feb 3, 2026
723eaf4
Simplify examples
JakeSCahill Feb 3, 2026
40c87e5
Fix label
JakeSCahill Feb 3, 2026
bd2797d
Fix label
JakeSCahill Feb 3, 2026
4b67d29
Fix label
JakeSCahill Feb 3, 2026
5a4ba3b
Merge branch 'ai-agents-documentation' into adp-pkg1
paulohtb6 Feb 3, 2026
7764ca7
Merge branch 'DOC-1867-Document-feature-AI-Gateway-help-cloud-team-po…
paulohtb6 Feb 3, 2026
81da213
force build
paulohtb6 Feb 3, 2026
74f55f2
Merge branch 'DOC-1901-document-feature-adp-execution-logs-ui-package…
paulohtb6 Feb 3, 2026
30709dc
update nav.adoc
micheleRP Feb 3, 2026
ad7a88d
Merge branch 'DOC-1867-Document-feature-AI-Gateway-help-cloud-team-po…
paulohtb6 Feb 3, 2026
2261b3e
fix nav
paulohtb6 Feb 3, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 29 additions & 15 deletions .github/workflows/test-mcp-examples.yaml
Original file line number Diff line number Diff line change
@@ -1,22 +1,18 @@
name: Test MCP Examples
name: Test Pipeline Examples

on:
push:
branches:
- main
paths:
- 'modules/ai-agents/examples/**/*.yaml'
- 'modules/ai-agents/examples/test-mcp-examples.sh'
pull_request:
branches:
- main
paths:
- 'modules/ai-agents/examples/**/*.yaml'
- 'modules/ai-agents/examples/test-mcp-examples.sh'
- 'modules/ai-agents/examples/**/*.sh'
- 'modules/develop/examples/**/*.yaml'
- 'modules/develop/examples/**/*.sh'

jobs:
test-all-examples:
name: Test All MCP Examples
name: Test All Pipeline Examples
runs-on: ubuntu-latest

steps:
Expand All @@ -39,15 +35,33 @@ jobs:
sudo wget -qO /usr/local/bin/yq https://github.com/mikefarah/yq/releases/latest/download/yq_linux_amd64
sudo chmod +x /usr/local/bin/yq

- name: Make test script executable
run: chmod +x modules/ai-agents/examples/test-mcp-examples.sh
- name: Make test scripts executable
run: |
find modules/ai-agents/examples -name "*.sh" -exec chmod +x {} \;
find modules/develop/examples -name "*.sh" -exec chmod +x {} \; 2>/dev/null || true

- name: Run MCP tools tests
run: |
cd modules/ai-agents/examples/mcp-tools
./test-mcp-tools.sh

- name: Run ai-agents pipeline tests
run: |
cd modules/ai-agents/examples/pipelines
./test-pipelines.sh

- name: Run MCP examples tests
- name: Run cookbook tests
run: |
cd modules/ai-agents/examples
./test-mcp-examples.sh
for dir in modules/develop/examples/cookbooks/*/; do
if [[ -f "${dir}test-"*".sh" ]]; then
echo "Testing ${dir}..."
cd "${dir}"
./test-*.sh
cd - > /dev/null
fi
done

- name: Test Summary
if: always()
run: |
echo "::notice title=MCP Examples Testing::All Cloud MCP examples have been validated"
echo "::notice title=Pipeline Examples Testing::All pipeline examples have been validated"
269 changes: 230 additions & 39 deletions docs-data/personas.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,34 +2,77 @@
#
# These personas represent the target audience for Redpanda Cloud documentation.
# Use these when assigning :personas: attributes to documentation pages.
#
# This persona set covers two domains:
# 1. Streaming/Data Platform: Real-time data streaming, connectors, pipelines
# 2. Agentic Data Platform (ADP): AI agent development, governance, enterprise AI adoption

schema_version: "1.0"
repository: cloud-docs

personas:
- id: app_developer
name: Application Developer
description: Builds applications that produce and consume data from Redpanda Cloud
experience_level: intermediate
# ============================================================================
# TIER 1: Executive & Governance
# ============================================================================

- id: executive
name: Executive Stakeholder
description: CIO/CAIO/Head of AI Strategy driving enterprise AI adoption and governance
experience_level: executive
goals:
- Connect applications to Redpanda Cloud clusters
- Produce and consume messages reliably
- Implement proper error handling and retries
- Optimize client performance
- Drive enterprise-wide AI adoption strategy
- Ensure ROI on AI investments
- Establish governance framework for agent deployments
- Manage cost and resource allocation
- Ensure compliance with organizational policies
pain_points:
- Authentication and connection configuration
- Understanding Kafka client options
- Debugging connectivity issues
- Choosing the right client library
- Lack of visibility into agent usage and costs
- Difficulty enforcing governance at scale
- Unclear ROI metrics for AI initiatives
- Risk of shadow AI deployments
- Integration with existing enterprise systems
content_preferences:
- Working code examples in multiple languages
- Connection configuration templates
- Client library comparisons
- Performance tuning guides
- High-level governance frameworks
- ROI and cost analysis
- Compliance and audit capabilities
- Executive dashboards and reporting
- Strategic planning guides
typical_content_types:
- how-to
- tutorial
- overview
- concepts
- best-practices

- id: security_leader
name: Security & Risk Leader
description: CISO/Compliance Officer protecting systems and enforcing data protection policies
experience_level: advanced
goals:
- Enforce agent policy and access controls
- Maintain audit trails for compliance
- Protect sensitive data and credentials
- Manage risk across agent deployments
- Ensure regulatory compliance
pain_points:
- Agent access to sensitive systems
- Lack of visibility into agent actions
- Difficult to audit agent behavior
- Credential management and rotation
- Compliance with data protection regulations
content_preferences:
- Security architecture patterns
- Policy enforcement mechanisms
- Audit trail documentation
- Compliance certification guides
- Incident response procedures
typical_content_types:
- concepts
- reference
- best-practices
- troubleshooting

# ============================================================================
# TIER 2: Platform Operations
# ============================================================================

- id: platform_admin
name: Platform Administrator
Expand All @@ -55,47 +98,97 @@ personas:
- reference
- best-practices

- id: data_engineer
name: Data Engineer
description: Builds data pipelines using managed connectors and Redpanda Connect
experience_level: intermediate
- id: ai_platform_engineer
name: AI/ML Platform Engineer
description: Operates agent infrastructure, runtimes, and connectivity with governance controls
experience_level: advanced
goals:
- Set up managed connectors to move data between systems
- Transform and route data reliably
- Monitor connector and pipeline health
- Handle errors and retries
- Deploy and operate agent runtime infrastructure
- Configure governance controls and policies
- Monitor agent performance and resource usage
- Onboard and manage MCP servers
- Ensure agent observability and debugging
pain_points:
- Connector configuration complexity
- Debugging failed connectors
- Schema management and evolution
- Performance tuning
- Complex agent runtime configuration
- Difficult to troubleshoot agent failures
- Managing agent resource allocation
- Integrating governance with existing tools
- Scaling agent infrastructure
content_preferences:
- Connector setup guides
- Transformation examples
- Error handling patterns
- Monitoring and troubleshooting
- Infrastructure setup guides
- Governance configuration patterns
- Observability and monitoring setup
- Performance tuning documentation
- Troubleshooting workflows
typical_content_types:
- how-to
- cookbook
- reference
- troubleshooting
- best-practices

- id: ai_agent_developer
name: AI Agent Developer
description: Builds AI agents and integrations using MCP tools and LLM frameworks
# ============================================================================
# TIER 3: Builders & Developers
# ============================================================================

- id: app_developer
name: Application Developer
description: Builds applications that produce and consume data from Redpanda Cloud
experience_level: intermediate
goals:
- Connect applications to Redpanda Cloud clusters
- Produce and consume messages reliably
- Implement proper error handling and retries
- Optimize client performance
pain_points:
- Authentication and connection configuration
- Understanding Kafka client options
- Debugging connectivity issues
- Choosing the right client library
content_preferences:
- Working code examples in multiple languages
- Connection configuration templates
- Client library comparisons
- Performance tuning guides
typical_content_types:
- how-to
- tutorial
- reference

- id: agent_developer
name: Agent Developer
description: Builds AI agents, agentic workflows, and MCP tools that integrate with Redpanda Cloud and ADP
experience_level: intermediate
goals:
# MCP and streaming integration
- Create MCP tools that AI assistants can discover and use
- Deploy MCP servers to Redpanda Cloud
- Integrate with AI/LLM applications
- Debug agent-tool interactions
# Agentic workflows and governed deployment
- Build agents and workflows that solve business problems
- Use ADP catalog, templates, and curated datasets
- Design reasoning patterns and tool interactions
- Deploy agents into governed runtime
pain_points:
# MCP and integration challenges
- MCP configuration syntax
- Testing tools before deployment
- Limited AI-specific examples
# ADP and governance challenges
- Hard to discover existing templates, MCP servers, datasets
- Unclear access policies
- Brittle multi-step integrations
- Inconsistent testing/debugging environments
content_preferences:
# Code examples and patterns
- Working code examples with AI context
- Testing and debugging workflows
- Integration patterns
# Catalog and governance
- Rich catalog of agent templates and tools
- Governance introspection (what agent can/can't do)
- Replay-based debugging
- Streamlined deployment workflows
typical_content_types:
- tutorial
- how-to
Expand Down Expand Up @@ -127,6 +220,81 @@ personas:
- reference
- best-practices

# ============================================================================
# TIER 4: Data & Knowledge Management
# ============================================================================

- id: data_engineer
name: Data Engineer
description: Builds data pipelines with managed connectors AND creates curated datasets for agent consumption
experience_level: intermediate
goals:
# Data movement and pipelines
- Set up managed connectors to move data between systems
- Transform and route data reliably
- Monitor connector and pipeline health
- Handle errors and retries
# Agent-ready datasets and RAG
- Create agent-ready datasets with federated SQL
- Ensure data quality and freshness for agents
- Expose data safely through governed views
- Provide clean RAG context via MCP servers
pain_points:
# Connector and pipeline challenges
- Connector configuration complexity
- Debugging failed connectors
- Schema management and evolution
- Performance tuning
# Data curation for agents
- Siloed data across sources
- Fragile RAG sources
- Schema drift
- Difficulty providing agent-ready datasets quickly
content_preferences:
# Connector and transformation
- Connector setup guides
- Transformation examples
- Error handling patterns
- Monitoring and troubleshooting
# Federated data and RAG
- Federated SQL query examples
- Governed view patterns
- RAG context design
- Data lineage visualization
typical_content_types:
- how-to
- cookbook
- troubleshooting
- reference

- id: knowledge_manager
name: Knowledge & Operations Manager
description: Maintains organizational documentation and knowledge bases for agent consumption
experience_level: intermediate
goals:
- Ingest and maintain organizational knowledge bases
- Ensure content freshness and accuracy
- Optimize vector search for agent queries
- Manage knowledge base access and permissions
pain_points:
- Stale or outdated documentation
- Difficult to index and search content
- Managing content from multiple sources
- Ensuring agent retrieval accuracy
content_preferences:
- KB ingestion workflows
- Vector search optimization guides
- Content freshness strategies
- Access control patterns
typical_content_types:
- how-to
- best-practices
- troubleshooting

# ============================================================================
# TIER 5: Evaluation & End Users
# ============================================================================

- id: evaluator
name: Technical Evaluator
description: Assessing Redpanda Cloud for their organization
Expand All @@ -150,4 +318,27 @@ personas:
- overview
- concepts
- tutorial
- get-started

- id: business_user
name: Business End User
description: Uses agent-powered automations to complete business tasks
experience_level: beginner
goals:
- Complete tasks efficiently using agents
- Understand what agents can and cannot do
- Trust agent recommendations and actions
- Report issues when agents fail
pain_points:
- Unclear agent capabilities
- Unexpected agent behavior
- Lack of transparency in agent actions
- Difficulty getting help when agents fail
content_preferences:
- Simple, task-oriented guides
- Agent capability overviews
- Troubleshooting for common issues
- Trust and transparency documentation
typical_content_types:
- overview
- how-to
- troubleshooting
Loading