OpenWriterControle/evals/agents/subagents/README.md
Darren Hinde c8f7103cb6
refactor(evals): consolidate documentation and enhance test infrastructure (#56)
* feat(agents): implement category-based agent organization system

- Organize agents into domain categories (core, development, content, data, product, learning)
- Move 10 agents to category subdirectories with proper git rename tracking
- Update 13 subagents with category and type metadata in frontmatter
- Add category metadata files (0-category.json) documenting common patterns
- Implement local registry fallback in install script for offline development
- Add comprehensive validation suite with 15 automated tests (100% pass rate)
- Enhance registry validation with duplicate ID and consistency checks
- Update eval framework with intelligent path resolution (backward compatible)
- Archive legacy eval structure to _archive/ for reference
- Update all documentation to reflect category-based structure
- Bump version to 0.5.0 with accurate CHANGELOG

Technical Details:
- 23 agents organized (10 category agents, 13 subagents)
- 6 category directories created
- Path resolution supports both agent IDs and category paths
- Registry schema updated to v2.0.0
- 159 files changed, 872 insertions(+), 10738 deletions(-)

BREAKING CHANGE: Agent file paths now use category structure. Update references from .opencode/agent/openagent.md to .opencode/agent/core/openagent.md. Eval framework maintains backward compatibility via path resolution.

* refactor(evals): consolidate documentation and enhance test infrastructure

- Remove temporary project tracking files (PHASE_5_COMPLETE, PROJECT_COMPLETE, etc.)
- Consolidate evaluation framework docs into main README
- Enhance test execution with improved logging and multi-prompt support
- Move system-builder from core to meta category
- Add comprehensive test suites for openagent with organized structure
- Create evaluation test structure for all subagents
- Clean up archived workflows and redundant documentation
- Update registry to reflect new agent organization
- Add shared test templates and golden test patterns

* feat(ci): add manual trigger support for bot-created PRs in validate-registry workflow

- Add pr_number input to workflow_dispatch for manually triggering validation
- Fetch PR details dynamically when triggered manually
- Support both automatic (PR event) and manual (workflow_dispatch) triggers
- Enable validation of bot-created PRs like automated version bumps
- Update branch detection and push logic to handle both trigger types
- Add documentation explaining how to manually trigger for bot PRs

* feat(evals): add explicit context file validation to test framework

- Add expectedContextFiles field to test YAML schema for explicit context file specification
- Enhance context-loading-evaluator to support both auto-detect and explicit validation modes
- Update documentation with comprehensive guide and examples
- Clean up archived legacy test structure (90+ old test files)
- Add new example tests demonstrating explicit context validation
- Backward compatible with existing tests

* feat(evals): add multi-agent logging system and performance optimizations

Implement comprehensive multi-agent logging and performance improvements for the eval framework.

Task 01: Multi-Agent Logging System
- Add complete hierarchical logging module (evals/framework/src/logging/)
  - SessionTracker: tracks parent-child delegation hierarchies
  - MultiAgentLogger: pretty-prints logs with visual indentation
  - Formatters: box characters and emoji formatting
  - 37 passing unit tests (session-tracker, logger, integration)
- Integrate with SDK event stream handler
  - Hook into session.created, message.updated, message.part.updated events
  - Real-time child session detection via timestamp heuristics
  - Message deduplication for cleaner output
- Enable in debug mode only (<1% performance overhead)
- Add demo script and comprehensive documentation

Task 02: Performance Optimizations
- Reduce grace period from 5s to 2s (67% reduction, 10-20% faster tests)
- Add PerformanceMetricsEvaluator for bottleneck identification
  - Collects tool latencies, inference time, idle time
  - Provides full performance visibility
- Update smoke test to validate delegation (core feature)
  - Replace simple read test with multi-agent delegation test
  - Tests both parent and child agent functionality
  - Validates multi-agent logging system

Results:
- 37 unit tests passing
- Smoke test passing (95/100 score)
- Clean hierarchical logging output
- 10-20% faster test execution
- Full multi-agent visibility

Files changed: 16 files, +2678 lines
Time saved: ~6-8 days (completed in 6 hours vs 3-5 day estimate)

* feat(evals): show child agent execution in non-debug mode

- Enable MultiAgentLogger in both debug and non-debug modes
- Add verbose parameter to control output level
- Non-verbose mode shows concise child session lifecycle:
  - Child agent started message
  - Child agent completed with duration
- Verbose mode (--debug) shows full delegation hierarchy
- Update documentation to reflect new behavior

This provides visibility into delegation without overwhelming output,
giving confidence that child agents are actually running.

* feat(evals): improve delegation testing and behavior validation

Major improvements to eval framework:

Test Suite:
- Add 00-smoke-test.yaml (basic read operation)
- Rename 01-smoke-test.yaml → 02-delegation-test.yaml (delegation test)
- Add simple-responder test agent for delegation testing
- Add debug test: simple-subagent-call.yaml

Evaluators:
- Add agent-model-evaluator.ts for agent/model validation
- Enhance behavior-evaluator.ts with detailed task tool output
- Improve delegation-evaluator.ts with better evidence tracking

Schema & Execution:
- Add expectedAgent and expectedModel to test schema
- Improve test executor with better logging and error handling

Documentation:
- Update evals/README.md with new features and performance improvements
- Remove outdated MULTI_AGENT_LOGGING_COMPLETE.md

Registry:
- Add simple-responder test agent to registry

Fixes:
- Fix dashboard.sh path resolution

These changes provide better visibility into delegation, improved test
coverage, and clearer validation of agent behavior.

* chore: add GitHub Actions workflow and plugin documentation

- Add .github/workflows/evals/run-evaluations.yml for automated eval testing
- Add dev/ai-tools/opencode/plugins/Plugin-inspiration.md for plugin development reference
2025-12-18 09:52:11 +00:00

267 lines
7.9 KiB
Markdown

# Subagent Evaluation Tests
## Overview
This directory contains evaluation tests for all 14 OpenCode subagents. Each subagent has its own test suite with configuration, smoke tests, and placeholder directories for prompt variants.
## Directory Structure
```
subagents/
├── code/ # Code-focused subagents (parent: opencoder)
│ ├── build-agent/
│ ├── codebase-pattern-analyst/
│ ├── coder-agent/
│ ├── reviewer/
│ └── tester/
├── core/ # Core orchestration subagents (parent: openagent)
│ ├── context-retriever/
│ ├── documentation/
│ └── task-manager/
├── system-builder/ # System builder subagents (parent: system-builder)
│ ├── agent-generator/
│ ├── command-creator/
│ ├── context-organizer/
│ ├── domain-analyzer/
│ └── workflow-designer/
└── utils/ # Utility subagents (parent: openagent)
└── image-specialist/
```
Each subagent directory contains:
- `config/config.yaml` - Test configuration
- `tests/smoke-test.yaml` - Basic sanity check
- `prompts/` - Placeholder for model-specific prompt variants
- `README.md` - Subagent-specific documentation
## Subagent Inventory
### Code Subagents (Parent: opencoder)
| Subagent | Description | Status |
|----------|-------------|--------|
| **build-agent** | Type checking and build validation | ✅ Smoke test ready |
| **codebase-pattern-analyst** | Finding similar implementations | ✅ Smoke test ready |
| **coder-agent** | Focused coding subtasks | ✅ Smoke test ready |
| **reviewer** | Code review and quality assurance | ✅ Smoke test ready |
| **tester** | Test authoring and TDD | ✅ Smoke test ready |
### Core Subagents (Parent: openagent)
| Subagent | Description | Status |
|----------|-------------|--------|
| **context-retriever** | Context search and retrieval | ✅ Smoke test ready |
| **documentation** | Documentation authoring | ✅ Smoke test ready |
| **task-manager** | Task breakdown with dependency tracking | ✅ Smoke test ready |
### System Builder Subagents (Parent: system-builder)
| Subagent | Description | Status |
|----------|-------------|--------|
| **agent-generator** | XML-optimized agent generation | ✅ Smoke test ready |
| **command-creator** | Custom slash command creation | ✅ Smoke test ready |
| **context-organizer** | Context file organization | ✅ Smoke test ready |
| **domain-analyzer** | Domain concept analysis | ✅ Smoke test ready |
| **workflow-designer** | Workflow definition design | ✅ Smoke test ready |
### Utils Subagents (Parent: openagent)
| Subagent | Description | Status |
|----------|-------------|--------|
| **image-specialist** | Image editing and analysis | ✅ Smoke test ready |
## Running Tests
### Quick Start
```bash
# Test a specific subagent (standalone mode)
npm run eval:sdk -- --subagent=coder-agent
# Test via parent agent (delegation mode)
npm run eval:sdk -- --subagent=coder-agent --delegate
# Using Makefile shortcuts
make test-subagent SUBAGENT=coder-agent
make test-subagent-delegate SUBAGENT=coder-agent
```
### Test All Subagents
```bash
# Run smoke tests for all code subagents
for agent in build-agent codebase-pattern-analyst coder-agent reviewer tester; do
npm run eval:sdk -- --subagent=$agent --pattern="**/smoke-test.yaml"
done
# Run smoke tests for all core subagents
for agent in context-retriever documentation task-manager; do
npm run eval:sdk -- --subagent=$agent --pattern="**/smoke-test.yaml"
done
# Run smoke tests for all system-builder subagents
for agent in agent-generator command-creator context-organizer domain-analyzer workflow-designer; do
npm run eval:sdk -- --subagent=$agent --pattern="**/smoke-test.yaml"
done
# Run smoke test for utils subagent
npm run eval:sdk -- --subagent=image-specialist --pattern="**/smoke-test.yaml"
```
### Verbose Output
```bash
# See full conversation and tool calls
npm run eval:sdk -- --subagent=coder-agent --verbose
```
## Test Modes
### Standalone Mode (Default)
- Forces `mode: primary` in the subagent file
- Tests subagent directly without parent delegation
- Useful for isolated functionality testing
- **Use case:** Unit testing subagent behavior
### Delegation Mode
- Tests subagent via its parent agent
- Simulates real-world usage patterns
- Parent agent delegates to subagent
- **Use case:** Integration testing
## Test Suites
Each subagent supports three test suites:
1. **smoke** - Basic sanity checks (✅ Implemented)
2. **standalone** - Isolated functionality tests (🚧 TODO)
3. **delegation** - Parent delegation scenarios (🚧 TODO)
## Adding New Tests
1. Navigate to the subagent's `tests/` directory
2. Create a new YAML test file following the schema:
```yaml
id: subagent-name-test-id
name: "Test Name"
description: |
Test description
category: developer
prompts:
- text: |
Your test prompt here
approvalStrategy:
type: auto-approve # or manual-approve
behavior:
mustUseTools:
- tool-name
minToolCalls: 1
maxToolCalls: 5
expectedViolations:
- rule: approval-gate
shouldViolate: false
severity: error
timeout: 60000
tags:
- subagent
- subagent-name
- test-suite-name
```
3. Update the subagent's README.md
4. Run the test to verify
## Prompt Variants
The `prompts/` directory in each subagent is reserved for model-specific prompt variants:
```
prompts/
├── gpt.md # GPT-optimized prompts
├── gemini.md # Gemini-optimized prompts
├── llama.md # Llama-optimized prompts
├── grok.md # Grok-optimized prompts
└── README.md # Variant documentation
```
**Status:** 🚧 Not yet implemented (directories created with .gitkeep)
## File Statistics
- **Total subagents:** 14
- **Config files:** 14 (config.yaml)
- **Smoke tests:** 14 (smoke-test.yaml)
- **Test configs:** 14 (config.yaml)
- **READMEs:** 14
- **Prompt directories:** 14 (with .gitkeep)
- **Total files:** 56
## Related Documentation
- [Subagent Testing Guide](../../SUBAGENT_TESTING.md) - Comprehensive testing guide
- [Eval Framework Guide](../../README.md) - Main evaluation framework documentation
- [Creating Tests](../../CREATING_TESTS.md) - Test authoring guide
- [Agent Source Files](.opencode/agent/subagents/) - Original subagent definitions
## Next Steps
### Immediate Priorities
1. **Run Smoke Tests** - Verify all 14 smoke tests pass
```bash
# Test each subagent
npm run eval:sdk -- --subagent=coder-agent
npm run eval:sdk -- --subagent=task-manager
# ... etc
```
2. **Create Standalone Test Suite** - Add comprehensive standalone tests
- Focus on core functionality
- Test tool usage patterns
- Validate approval gates
- Check context loading
3. **Create Delegation Test Suite** - Add parent delegation tests
- Test real-world delegation scenarios
- Validate parent → subagent communication
- Check handoff patterns
4. **Add Prompt Variants** - Create model-specific prompts
- GPT optimizations
- Gemini optimizations
- Llama optimizations
### Long-term Goals
- [ ] Achieve 100% smoke test pass rate
- [ ] Create comprehensive standalone test coverage
- [ ] Create comprehensive delegation test coverage
- [ ] Add performance benchmarking
- [ ] Add multi-model testing
- [ ] Document best practices per subagent
- [ ] Create test templates for common patterns
## Contributing
When adding tests for subagents:
1. Follow the existing directory structure
2. Use descriptive test IDs and names
3. Add appropriate tags for filtering
4. Document expected behavior
5. Update the subagent's README
6. Run tests locally before committing
## Support
For issues or questions:
- See [SUBAGENT_TESTING.md](../../SUBAGENT_TESTING.md) for detailed testing guide
- Check individual subagent READMEs for specific documentation
- Review [evals/README.md](../../README.md) for framework documentation