Skip to content

raphaelsap/agentcoach

Repository files navigation

🎯 AgentCoach

Agent quality analysis and repair SDK for OpenTelemetry traces

AgentCoach analyzes agent execution traces to detect quality issues, identify root causes, and provide actionable recommendations for improvement. It works with OpenTelemetry/OpenInference-style traces and supports runtime repair loops.

Python 3.11+ License: MIT

✨ Features

  • πŸ” Trace Analysis: Ingest and analyze OpenTelemetry/OpenInference traces
  • 🎯 7 Quality Detectors:
    • Output contract/schema validation
    • Evidence grounding verification
    • Tool-use failure detection
    • Loop/planning failure detection
    • State/constraint loss detection
    • Policy/tone compliance
    • Consistency detection (stub)
  • πŸ“Š Rich Reporting: JSON and HTML reports with quality scores
  • πŸ”§ Runtime Repair: Automatic output repair with evidence grounding
  • πŸ’‘ Engineering Coach: Actionable recommendations (prompt diffs, retrieval settings, etc.)
  • πŸ§ͺ Canary Tests: Auto-generate regression test suites from failures
  • πŸ”— LangGraph Integration: Drop-in quality guard node
  • πŸ€– Optional LLM Judge: OpenAI, Anthropic, or SAP BTP AI Core

πŸš€ Quick Start

Installation

# Clone the repository
git clone <repo-url>
cd agentcoach

# Install in development mode
pip install -e .

# Or install with dev dependencies
pip install -e ".[dev]"

Initialize Configuration

agentcoach init

This creates:

  • agentcoach.yaml - Configuration file
  • .env.example - Environment variables template

Analyze a Trace

agentcoach analyze --trace examples/sample_trace.json --out results/

This generates:

  • results/report.json - Structured findings
  • results/report.html - Interactive HTML report

View Results

Open results/report.html in your browser to see:

  • Quality score
  • Findings by severity and category
  • Engineering recommendations
  • Suggested fixes

πŸ“– Usage

CLI Commands

1. Initialize Project

agentcoach init

2. Analyze Traces

# Basic analysis
agentcoach analyze --trace path/to/trace.json --out output_dir/

# With custom config
agentcoach analyze --trace trace.json --out results/ --config agentcoach.yaml

# With LLM judge (requires API keys in .env)
agentcoach analyze --trace trace.json --out results/ --llm-judge

3. Repair Output

# Repair with heuristics only
agentcoach repair --trace trace.json --out repaired/

# Repair with LLM provider
agentcoach repair --trace trace.json --out repaired/ --llm-provider openai

4. Generate Canary Tests

agentcoach canary --report results/report.json --suite canary_tests/

Python SDK

from agentcoach import load_trace, analyze_trace
from agentcoach.report import generate_report

# Load and analyze trace
trace = load_trace("path/to/trace.json")
findings = analyze_trace(trace)

# Generate reports
generate_report(trace, findings, "output_dir/")

LangGraph Integration

from agentcoach.langgraph import QualityGuardNode

# Create quality guard node
quality_guard = QualityGuardNode(
    contract_schema="schemas/default_contract.json",
    policy_pack="schemas/default_policy.json",
    auto_repair=True,
)

# Add to your LangGraph
from langgraph.graph import StateGraph

graph = StateGraph(AgentState)
graph.add_node("quality_guard", quality_guard)
graph.add_edge("draft_answer", "quality_guard")
graph.add_edge("quality_guard", END)

app = graph.compile()

See examples/langgraph_demo.py for a complete example.

πŸ”§ Configuration

agentcoach.yaml

# Output contract schema
contract_schema: schemas/default_contract.json

# Policy pack
policy: schemas/default_policy.json

# LLM Judge
llm_judge:
  enabled: false
  provider: openai  # openai, anthropic, or sap

# Detector configuration
detectors:
  schema:
    enabled: true
  grounding:
    enabled: true
    require_citations: true
  tool_use:
    enabled: true
  loops:
    enabled: true
    max_repeats: 3
  state:
    enabled: true
  policy_tone:
    enabled: true
  consistency:
    enabled: false

Environment Variables

Create a .env file (see .env.example):

# OpenAI
OPENAI_API_KEY=your_key_here
OPENAI_MODEL=gpt-4o-mini

# Anthropic
ANTHROPIC_API_KEY=your_key_here
ANTHROPIC_MODEL=claude-3-5-sonnet-20241022

# SAP BTP AI Core
AICORE_BASE_URL=https://api.ai.prod.eu-central-1.aws.ml.hana.ondemand.com
AICORE_CLIENT_ID=your_client_id
AICORE_CLIENT_SECRET=your_client_secret
AICORE_RESOURCE_GROUP=default
AICORE_MODEL=gpt-4

πŸ“Š Trace Format

AgentCoach supports OpenTelemetry and simplified trace formats:

Simplified Format

{
  "trace_id": "trace-001",
  "spans": [
    {
      "span_id": "span-1",
      "name": "agent_run",
      "kind": "agent",
      "attributes": {
        "input.value": "User query",
        "output.value": "Agent response"
      }
    },
    {
      "span_id": "span-2",
      "parent_span_id": "span-1",
      "name": "retrieval",
      "kind": "retrieval",
      "attributes": {
        "retrieval.query": "search query",
        "documents": [
          {"content": "Retrieved document text"}
        ]
      }
    }
  ]
}

Exporting from LangGraph

from langchain_core.tracers import LangChainTracer
import json

tracer = LangChainTracer()
result = graph.invoke(input, config={"callbacks": [tracer]})

# Export trace
with open("trace.json", "w") as f:
    json.dump(tracer.runs[0].dict(), f)

πŸ§ͺ Testing

# Run all tests
pytest

# Run with coverage
pytest --cov=agentcoach --cov-report=html

# Run specific test
pytest tests/test_schema_detector.py -v

🎯 Quality Detectors

1. Schema Detector

Validates output against JSON schema contracts.

Checks:

  • Required fields present
  • Correct data types
  • Valid JSON format

2. Grounding Detector

Verifies answers are grounded in evidence.

Checks:

  • Citations present
  • Evidence referenced in answer
  • Tool outputs used

3. Tool-Use Detector

Detects tool execution failures.

Checks:

  • Tool errors
  • Ignored tool outputs
  • Premature final answers

4. Loop Detector

Identifies infinite loops and planning failures.

Checks:

  • Repeated tool calls
  • Repeated LLM prompts
  • Excessive iterations

5. State Detector

Tracks constraint loss.

Checks:

  • User constraints maintained
  • Requirements addressed

6. Policy/Tone Detector

Enforces policy compliance.

Checks:

  • Banned phrases
  • Answer length limits
  • Tone requirements

7. Consistency Detector

Multi-run variance analysis (MVP stub).

πŸ’‘ Engineering Recommendations

AgentCoach provides actionable recommendations:

Prompt Engineering

--- system_prompt
+++ system_prompt
 You are a helpful assistant.
+
+Always format your response as JSON with:
+{"answer": "...", "confidence": 0.0-1.0, "citations": [...]}

Retrieval Settings

  • Increase top_k from 3 to 5-10
  • Add re-ranking step
  • Implement query rewriting

Error Handling

def call_tool_with_retry(tool_name, args, max_retries=2):
    for attempt in range(max_retries + 1):
        try:
            return execute_tool(tool_name, args)
        except Exception as e:
            if attempt < max_retries:
                args = fix_tool_args(tool_name, args, error=str(e))
            else:
                return {"error": str(e)}

Architecture

  • Add loop detection
  • Implement memory trimming
  • Add policy validation node

πŸ§ͺ Canary Tests

Generate regression tests from failures:

agentcoach canary --report results/report.json --suite canary_tests/

This creates:

  • canary_tests/cases.jsonl - Test cases
  • canary_tests/test_canary.py - Pytest file

Implement the run_agent() function and run:

pytest canary_tests/test_canary.py -v

πŸ“ Project Structure

agentcoach/
β”œβ”€β”€ agentcoach/
β”‚   β”œβ”€β”€ __init__.py
β”‚   β”œβ”€β”€ cli.py              # CLI commands
β”‚   β”œβ”€β”€ models.py           # Data models
β”‚   β”œβ”€β”€ trace_ingest.py     # Trace parsing
β”‚   β”œβ”€β”€ config.py           # Configuration
β”‚   β”œβ”€β”€ contracts.py        # Schema validation
β”‚   β”œβ”€β”€ report.py           # Report generation
β”‚   β”œβ”€β”€ repair.py           # Runtime repair
β”‚   β”œβ”€β”€ judge.py            # LLM judge adapters
β”‚   β”œβ”€β”€ canary.py           # Test generation
β”‚   β”œβ”€β”€ langgraph.py        # LangGraph integration
β”‚   └── detectors/          # Quality detectors
β”œβ”€β”€ schemas/                # Default schemas
β”œβ”€β”€ examples/               # Example code
β”œβ”€β”€ tests/                  # Test suite
└── README.md

🀝 Contributing

Contributions welcome! Please:

  1. Fork the repository
  2. Create a feature branch
  3. Add tests for new features
  4. Run pytest and ruff check
  5. Submit a pull request

πŸ“„ License

MIT License - see LICENSE file for details.

πŸ™ Acknowledgments

Built for analyzing agent quality with OpenTelemetry/OpenInference traces.

πŸ“ž Support

  • Issues: GitHub Issues
  • Documentation: This README
  • Examples: See examples/ directory

Made with ❀️ for better agent quality

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages