* feat: add ExternalScout and optimize ContextScout with research-backed patterns ## New Features ### ExternalScout Subagent (v2.0.0) - Fetches live, version-specific documentation for external libraries via Context7 API - Supports 18+ libraries: Drizzle, Better Auth, Next.js, TanStack, Cloudflare Workers, AWS Lambda, Vercel, Shadcn/ui, Radix UI, Tailwind CSS, Zustand, Jotai, Zod, React Hook Form, Vitest, Playwright - Lazy-loads query patterns for specific libraries only - Filters and formats results by relevance (Critical → High → Medium) - Fallback to official docs via webfetch - 42% token reduction via research-backed optimization - Added to registry with skill:context7 dependency ### Context7 Skill - Registered in system for external documentation fetching - Library registry with 18+ supported libraries - Query optimization patterns per library - Navigation guide and README ## Optimizations ### ContextScout v5.1.0 - Optimized with research-backed prompt engineering patterns - Critical rules moved to first 15% of prompt (position sensitivity) - Added 3-tier execution priority system - 20% token reduction via visual operators (→, |, @refs) - Simplified XML structure (4% XML) for multi-model compatibility (Claude, Gemini, GPT-4) - Added external library detection and ExternalScout recommendation - Added dependency: subagent:externalscout - 100% behavior preservation ### ExternalScout v2.0.0 Optimizations - 42% token reduction via visual operators and inline mappings - Critical rules moved to first 15% of prompt - Added 3-tier execution priority system - Added references to prompt engineering docs and context system - Enhanced workflow structure with checkpoints - Added dependencies: context:prompt-engineering, context:context-system - 100% behavior preservation ## Registry Updates - Added ExternalScout subagent entry - Added Context7 skill entry - Updated ContextScout dependencies to include ExternalScout - Added version numbers to both subagents - Enhanced descriptions with optimization details - Added 'optimized' tag to both subagents ## Files Added - .opencode/agent/subagents/core/externalscout.md - .opencode/skill/context7/README.md - .opencode/skill/context7/library-registry.md - .opencode/skill/context7/navigation.md - .opencode/agent/subagents/core/contextscout-v4-backup.md (backup) - .opencode/agent/subagents/core/externalscout-v1-backup.md (backup) ## Files Modified - .opencode/agent/subagents/core/contextscout.md (v4.0.0 → v5.1.0) - registry.json (added ExternalScout, Context7, updated ContextScout) - CHANGELOG.md (documented all changes) - VERSION (0.5.5 → 0.6.0) - package.json (0.5.5 → 0.6.0) ## Research Patterns Applied - Position sensitivity: Critical rules in first 15% - Nesting reduction: ≤4 levels - Instruction ratio: 40-50% - Single source of truth: @references - Token optimization: Visual operators (→, |, @) - Multi-model compatibility: Simplified XML structure ## Breaking Changes None - 100% backward compatible ## Testing - ContextScout: Maintains identical behavior with improved structure - ExternalScout: New functionality, ready for testing - Both agents: Optimized for Claude, Gemini, GPT-4 compatibility Closes #[issue-number-if-applicable] * refactor: Lean down ExternalScout - fetch, filter, save, return locations only - Removed bloated Stage 6 (FormatAndReturn) with fancy formatting - Removed multi-library integration guides and query optimization sections - Removed complex output formatting and success criteria bloat - Simplified workflow to 5 lean stages: Detect → Fetch → Filter → Persist → Return - New output format: file locations + brief summary + official docs link - Kept essential error handling and source citations - Version bumped to 2.0.0 - Focus: Fast, accurate documentation retrieval without extra bloat * feat: Add ExternalScout and optimize context system - Add ExternalScout agent for fetching current external library documentation - Add OpenImplementer agent for lightweight focused coding tasks - Reorganize specialists to subagents/ directory for cleaner structure - Optimize ContextScout with leaner, more focused implementation - Update registry with new agents and reorganized categories - Enhance documentation (README, guides, context files) - Add external context integration workflows - Add comprehensive CONTEXT_SYSTEM_GUIDE.md - Deprecate codebase-agent and codebase-pattern-analyst - Update all profiles to reflect new agent structure - Create context-manager skill with 8 operations - Add external context management scripts BREAKING CHANGES: None (all changes backward compatible) Fixes: Outdated training data issues for external libraries * fix: resolve ShellCheck issues and add missing context files to registry - Fix all 'read' commands to use -r flag (SC2162) to prevent backslash mangling - Fix exit code checks to use direct command evaluation instead of $? (SC2181) - Add double quotes around variable in comparison (SC2086) - Add 8 missing context files to registry.json: - external-libraries.md (new workflow for external library handling) - visual-development.md - development/README.md - learning/README.md - product/README.md - data/README.md - mastra-ai/README.md - context-bundle-template.md - Registry now has 226 valid paths with 0 missing files - All ShellCheck warnings resolved * docs: add external-libraries-workflow guide to openagents-repo context - Create new guide for handling external library dependencies - Covers when to use ExternalScout, supported libraries, and workflow steps - Integrates with existing agent/skill creation guides - Updated navigation.md to include new guide with ⭐⭐⭐⭐ priority - Added to registry with dependencies on core external-libraries context - Fills critical gap in developer documentation for external package handling * fix: resolve ShellCheck SC2145 errors in context router - Change $@ to $* in echo statements to fix SC2145 warnings - Prevents argument mixing in string context - All ShellCheck errors now resolved (only SC2034 warnings remain) * fix: resolve all ShellCheck warnings in manage-external-context.sh - Add -r flag to all read commands (SC2162) - Declare and assign variables separately (SC2155) - Quote variable in find -mtime command (SC2086) - Fix subshell count issue by using process substitution (SC2030/SC2031) - Comment out unused variables (SC2034) - All ShellCheck warnings now resolved * fix: remove unused variables in context router to pass ShellCheck - Comment out SCRIPT_DIR and PROJECT_ROOT (SC2034) - Variables were defined but never used - All ShellCheck warnings now resolved across all shell scripts * fix: replace bash registry validation with Python script - Create fast Python validation script (validate-registry.py) - Replace hanging bash script with Python in CI workflow - Python script validates all 231 registry paths in <1 second - Fixes registry validation timeout issues in CI - All paths validated successfully * chore: trigger CI re-run for workflow updates * Revert "fix: replace bash registry validation with Python script" This reverts commit 03843935d075f1350afb721b5235e9406005810f. * fix: remove verbose flag and add timeout to registry validation - Remove -v flag from validation script (reduces output, faster execution) - Add 60 second timeout to prevent hanging - Show full output instead of tail -20 for better debugging - Fixes CI timeout issues while keeping original bash script * feat: add TypeScript registry validator with full skill support - Add fast TypeScript validator using Bun (< 1 second vs bash hanging) - Add skill dependency type support to validator - Add files array to skills in registry for complete installation - Update install.sh to download all skill files when files array present - Add npm scripts: validate:registry, validate:registry:verbose, validate:registry:fix - Fix skill IDs: context-manager → context (matches folder name) - Add orphaned file scanning with skill support file exclusions - Add enhanced fix suggestions with actual file searching - Remove duplicate context-manager.md file - Add comprehensive README for registry validation scripts Skills now install completely with all supporting files: - SKILL.md (main definition) - router.sh (CLI entry point) - scripts/ (supporting scripts) - config/ (configuration files) - All other supporting files Validation results: - 231 paths validated (all valid) - 4 skills registered with complete file lists - Orphaned files reduced from 6 to 2 - Only 1 dependency issue remaining (context:prompt-engineering) * fix: use TypeScript validator in CI instead of hanging bash script - Install Bun in CI workflow - Switch from bash validator to TypeScript validator - Removes 60s timeout (TypeScript completes in <1s) - Fixes CI hanging issue on registry validation * chore: retrigger CI checks Empty commit to retrigger CI after workflow fix in PR #129 * fix: use official Bun setup action in CI - Replace manual Bun installation with oven-sh/setup-bun@v2 - Fixes PATH issue where bun wasn't available in subsequent steps - Ensures Bun is properly installed before running TypeScript validator * chore: retrigger CI after Bun setup fix in PR #131 Empty commit to retrigger CI once PR #131 is merged to main * fix: remove non-existent context:prompt-engineering dependency from ExternalScout |
||
|---|---|---|
| .. | ||
| content | ||
| core | ||
| data/data-analyst | ||
| development | ||
| README.md | ||
Prompt Library System
Multi-model prompt variants with integrated evaluation framework for testing and validation.
🎯 Quick Start
Testing a Prompt Variant
# Test with eval framework (recommended)
cd evals/framework
npm run eval:sdk -- --agent=openagent --prompt-variant=llama --suite=smoke-test
# Test with specific model
npm run eval:sdk -- --agent=openagent --prompt-variant=llama --model=ollama/llama3.2 --suite=core-tests
# View results
open ../results/index.html
Using a Variant Permanently
# Switch to a variant
./scripts/prompts/use-prompt.sh --agent=openagent --variant=llama
# Restore default (canonical agent file)
./scripts/prompts/use-prompt.sh --agent=openagent --variant=default
📁 Structure
.opencode/
├── agent/ # Canonical agent prompts (defaults)
│ ├── openagent.md # OpenAgent default (Claude-optimized)
│ └── opencoder.md # OpenCoder default
└── prompts/ # Model-specific variants
├── navigation.md # This file
├── openagent/ # OpenAgent variants
│ ├── gpt.md # GPT-4 optimized
│ ├── gemini.md # Gemini optimized
│ ├── grok.md # Grok optimized
│ ├── llama.md # Llama/OSS optimized
│ ├── TEMPLATE.md # Template for new variants
│ ├── navigation.md # Variant documentation
│ └── results/ # Per-variant test results
│ ├── default-results.json # Default (agent file) results
│ ├── gpt-results.json
│ ├── gemini-results.json
│ └── llama-results.json
└── opencoder/ # OpenCoder variants
└── ...
Architecture:
- Agent files (
.opencode/agent/*.md) = Canonical defaults (source of truth) - Prompt variants (
.opencode/prompts/<agent>/<model>.md) = Model-specific optimizations - Results always saved to
.opencode/prompts/<agent>/results/(including default)
🧪 Evaluation Framework Integration
Running Tests with Variants
The eval framework automatically:
- ✅ Switches to the specified variant
- ✅ Runs your test suite
- ✅ Tracks results per variant
- ✅ Restores the default prompt after tests
# Smoke test (1 test, ~30s)
npm run eval:sdk -- --agent=openagent --prompt-variant=llama --suite=smoke-test
# Core suite (7 tests, ~5-8min)
npm run eval:sdk -- --agent=openagent --prompt-variant=llama --suite=core-tests
# Custom test pattern
npm run eval:sdk -- --agent=openagent --prompt-variant=llama --pattern="01-critical-rules/**/*.yaml"
Auto-Model Detection
Variants specify recommended models in their YAML frontmatter:
---
model_family: llama
recommended_models:
- ollama/llama3.2
- ollama/qwen2.5
---
If you don't specify --model, the framework uses the first recommended model.
Results Tracking
Results are saved in two locations:
- Main results:
evals/results/latest.json(includesprompt_variantfield) - Per-variant:
.opencode/prompts/{agent}/results/{variant}-results.json
View in dashboard: evals/results/index.html (filter by variant)
📝 Creating a New Variant
Step 1: Copy Template
cp .opencode/prompts/openagent/TEMPLATE.md .opencode/prompts/openagent/my-variant.md
Step 2: Edit Metadata
---
model_family: oss
recommended_models:
- ollama/my-model
status: experimental
maintainer: your-name
description: Optimized for my specific use case
---
Step 3: Customize Prompt
Edit the prompt content below the frontmatter for your target model.
Step 4: Validate
# Validate the variant exists and metadata is correct
cd evals/framework
npm run eval:sdk -- --agent=openagent --prompt-variant=my-variant --suite=smoke-test
Step 5: Test Thoroughly
# Run core test suite
npm run eval:sdk -- --agent=openagent --prompt-variant=my-variant --suite=core-tests
# Check results
open ../results/index.html
Step 6: Document Results
Update .opencode/prompts/openagent/navigation.md with:
- Test results (pass rate, timing)
- Known issues or limitations
- Recommended use cases
🎯 Available Variants
OpenAgent
| Variant | Model Family | Status | Best For |
|---|---|---|---|
default |
Claude | ✅ Stable | Production use, Claude models |
gpt |
GPT | ✅ Stable | GPT-4, GPT-4o |
gemini |
Gemini | ✅ Stable | Gemini 2.0, Gemini Pro |
grok |
Grok | ✅ Stable | Grok models (free tier) |
llama |
Llama/OSS | ✅ Stable | Llama, Qwen, DeepSeek, other OSS |
See openagent/navigation.md for detailed test results.
OpenCoder
Coming soon.
🔧 Advanced Usage
Custom Test Suites
Create custom test suites for your variant:
# Create suite
cp evals/agents/openagent/config/smoke-test.json \
evals/agents/openagent/config/my-suite.json
# Edit suite (add your tests)
# Validate suite
cd evals/framework && npm run validate:suites openagent
# Run with your variant
npm run eval:sdk -- --agent=openagent --prompt-variant=my-variant --suite=my-suite
See evals/TEST_SUITE_VALIDATION.md for details.
Comparing Models
Test the same variant with different models:
# Test Llama 3.2
npm run eval:sdk -- --agent=openagent --prompt-variant=llama --model=ollama/llama3.2 --suite=core-tests
# Test Qwen 2.5
npm run eval:sdk -- --agent=openagent --prompt-variant=llama --model=ollama/qwen2.5 --suite=core-tests
# Compare results in dashboard
open evals/results/index.html
📊 Understanding Results
Dashboard Features
The results dashboard (evals/results/index.html) shows:
- ✅ Filter by prompt variant
- ✅ Filter by model
- ✅ Pass/fail rates per variant
- ✅ Test execution times
- ✅ Detailed test results
Result Files
Main results (evals/results/latest.json):
{
"meta": {
"agent": "openagent",
"model": "ollama/llama3.2",
"prompt_variant": "llama",
"model_family": "llama"
},
"summary": {
"total": 7,
"passed": 7,
"failed": 0,
"pass_rate": 1
}
}
Per-variant results (.opencode/prompts/openagent/results/llama-results.json):
- Tracks all test runs for this variant
- Shows trends over time
- Helps identify regressions
🚀 For Contributors
Creating a Variant for PR
- Create your variant in
.opencode/prompts/<agent>/<model>.md - Test thoroughly with eval framework
- Document results in agent README
- Submit PR with variant file only
PR Requirements
- ✅ Variant has YAML frontmatter with metadata
- ✅ Variant passes core test suite (≥85% pass rate)
- ✅ Results documented in agent README
- ✅ Agent file unchanged (unless updating default)
- ✅ No
default.mdfiles in prompts directory - ✅ CI validation passes
Validation
# Validate your variant
cd evals/framework
npm run eval:sdk -- --agent=openagent --prompt-variant=your-variant --suite=core-tests
# Ensure PR uses default
./scripts/prompts/validate-pr.sh
🎓 Design Principles
1. Agent Files are Canonical Defaults
- Agent files (
.opencode/agent/*.md) are the source of truth - Tested and production-ready
- Optimized for Claude (primary model)
- Modified through normal PR process
2. Variants are Model-Specific Optimizations
- Stored in
.opencode/prompts/<agent>/<model>.md - Optimized for specific models/use cases
- May have different trade-offs
- Results documented transparently
3. Results are Tracked
- Every test run tracked per variant
- Dashboard shows variant performance
- Easy to compare variants
4. Easy to Test
- One command to test any variant
- Automatic model detection
- Results saved automatically
5. Safe to Experiment
- Variants don't affect default
- Easy to switch and restore
- Test before committing
📚 Related Documentation
- Eval Framework Guide - How to run tests
- Test Suite Validation - Creating test suites
- OpenAgent Variants - OpenAgent-specific docs
- Contributing Guide - Contribution guidelines
🆘 Troubleshooting
Variant Not Found
# List available variants
ls .opencode/prompts/openagent/*.md
# Check variant exists
npm run eval:sdk -- --agent=openagent --prompt-variant=your-variant --suite=smoke-test
Tests Failing
- Check variant metadata (YAML frontmatter)
- Verify recommended model is available
- Run with debug flag:
--debug - Check results in dashboard
Model Not Available
# Check available models
# For Ollama: ollama list
# For OpenRouter: check openrouter.ai/models
# Specify model explicitly
npm run eval:sdk -- --agent=openagent --prompt-variant=llama --model=ollama/llama3.2
💡 Tips
- Start with smoke-test - Fast validation (1 test, ~30s)
- Use core-tests for thorough testing - 7 tests, ~5-8min
- Check dashboard regularly - Visual feedback on variant performance
- Document your findings - Help others by sharing results
- Test with multiple models - Same variant may perform differently
🔮 Future Enhancements
- Automated variant comparison reports
- Performance benchmarking across variants
- Variant recommendation based on model
- Historical trend analysis
- A/B testing framework
Questions? See openagent/navigation.md or open an issue.