193271091a
* 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
317 lines
8.5 KiB
Markdown
317 lines
8.5 KiB
Markdown
# Lookup: File Locations
|
|
|
|
**Purpose**: Quick reference for finding files
|
|
|
|
---
|
|
|
|
## Directory Tree
|
|
|
|
```
|
|
opencode-agents/
|
|
├── .opencode/
|
|
│ ├── agent/
|
|
│ │ ├── core/ # Core system agents
|
|
│ │ ├── development/ # Dev specialists
|
|
│ │ ├── content/ # Content creators
|
|
│ │ ├── data/ # Data analysts
|
|
│ │ ├── product/ # Product managers (ready)
|
|
│ │ ├── learning/ # Educators (ready)
|
|
│ │ └── subagents/ # Delegated specialists
|
|
│ │ ├── code/ # Code-related
|
|
│ │ ├── core/ # Core workflows
|
|
│ │ ├── system-builder/ # System generation
|
|
│ │ └── utils/ # Utilities
|
|
│ ├── command/ # Slash commands
|
|
│ ├── context/ # Shared knowledge
|
|
│ │ ├── core/ # Core standards & workflows
|
|
│ │ ├── development/ # Dev context
|
|
│ │ ├── content-creation/ # Content creation context
|
|
│ │ ├── data/ # Data context
|
|
│ │ ├── product/ # Product context
|
|
│ │ ├── learning/ # Learning context
|
|
│ │ └── openagents-repo/ # Repo-specific context
|
|
│ ├── prompts/ # Model-specific variants
|
|
│ ├── tool/ # Custom tools
|
|
│ └── plugin/ # Plugins
|
|
├── evals/
|
|
│ ├── framework/ # Eval framework (TypeScript)
|
|
│ │ ├── src/ # Source code
|
|
│ │ ├── scripts/ # Test utilities
|
|
│ │ └── docs/ # Framework docs
|
|
│ └── agents/ # Agent test suites
|
|
│ ├── core/ # Core agent tests
|
|
│ ├── development/ # Dev agent tests
|
|
│ └── content/ # Content agent tests
|
|
├── scripts/
|
|
│ ├── registry/ # Registry management
|
|
│ ├── validation/ # Validation tools
|
|
│ ├── testing/ # Test utilities
|
|
│ ├── versioning/ # Version management
|
|
│ ├── docs/ # Doc tools
|
|
│ └── maintenance/ # Maintenance
|
|
├── docs/ # Documentation
|
|
│ ├── agents/ # Agent docs
|
|
│ ├── contributing/ # Contribution guides
|
|
│ ├── features/ # Feature docs
|
|
│ └── getting-started/ # User guides
|
|
├── registry.json # Component catalog
|
|
├── install.sh # Installer
|
|
├── VERSION # Current version
|
|
└── package.json # Node dependencies
|
|
```
|
|
|
|
---
|
|
|
|
## Where Is...?
|
|
|
|
| Component | Location |
|
|
|-----------|----------|
|
|
| **Core agents** | `.opencode/agent/core/` |
|
|
| **Category agents** | `.opencode/agent/{category}/` |
|
|
| **Subagents** | `.opencode/agent/subagents/` |
|
|
| **Commands** | `.opencode/command/` |
|
|
| **Context files** | `.opencode/context/` |
|
|
| **Prompt variants** | `.opencode/prompts/{category}/{agent}/` |
|
|
| **Tools** | `.opencode/tool/` |
|
|
| **Plugins** | `.opencode/plugin/` |
|
|
| **Agent tests** | `evals/agents/{category}/{agent}/` |
|
|
| **Eval framework** | `evals/framework/src/` |
|
|
| **Registry scripts** | `scripts/registry/` |
|
|
| **Validation scripts** | `scripts/validation/` |
|
|
| **Documentation** | `docs/` |
|
|
| **Registry** | `registry.json` |
|
|
| **Installer** | `install.sh` |
|
|
| **Version** | `VERSION` |
|
|
|
|
---
|
|
|
|
## Where Do I Add...?
|
|
|
|
| What | Where |
|
|
|------|-------|
|
|
| **New core agent** | `.opencode/agent/core/{name}.md` |
|
|
| **New category agent** | `.opencode/agent/{category}/{name}.md` |
|
|
| **New subagent** | `.opencode/agent/subagents/{category}/{name}.md` |
|
|
| **New command** | `.opencode/command/{name}.md` |
|
|
| **New context** | `.opencode/context/{category}/{name}.md` |
|
|
| **Agent tests** | `evals/agents/{category}/{agent}/tests/` |
|
|
| **Test config** | `evals/agents/{category}/{agent}/config/config.yaml` |
|
|
| **Documentation** | `docs/{section}/{topic}.md` |
|
|
| **Script** | `scripts/{purpose}/{name}.sh` |
|
|
|
|
---
|
|
|
|
## Specific File Paths
|
|
|
|
### Core Files
|
|
|
|
```
|
|
registry.json # Component catalog
|
|
install.sh # Main installer
|
|
update.sh # Update script
|
|
VERSION # Current version (0.5.0)
|
|
package.json # Node dependencies
|
|
CHANGELOG.md # Release notes
|
|
README.md # Main documentation
|
|
```
|
|
|
|
### Core Agents
|
|
|
|
```
|
|
.opencode/agent/core/openagent.md
|
|
.opencode/agent/core/opencoder.md
|
|
```
|
|
|
|
### Meta Agents
|
|
|
|
```
|
|
.opencode/agent/meta/system-builder.md
|
|
```
|
|
|
|
### Development Agents
|
|
|
|
```
|
|
.opencode/agent/development/frontend-specialist.md
|
|
.opencode/agent/development/devops-specialist.md
|
|
.opencode/agent/core/openimplementer.md
|
|
```
|
|
|
|
### Content Agents
|
|
|
|
```
|
|
.opencode/agent/content/copywriter.md
|
|
.opencode/agent/content/technical-writer.md
|
|
```
|
|
|
|
### Key Subagents
|
|
|
|
```
|
|
.opencode/agent/TestEngineer.md
|
|
.opencode/agent/CodeReviewer.md
|
|
.opencode/agent/CoderAgent.md
|
|
.opencode/agent/TaskManager.md
|
|
.opencode/agent/DocWriter.md
|
|
```
|
|
|
|
### Core Context
|
|
|
|
```
|
|
.opencode/context/core/standards/code-quality.md
|
|
.opencode/context/core/standards/documentation.md
|
|
.opencode/context/core/standards/test-coverage.md
|
|
.opencode/context/core/standards/security-patterns.md
|
|
.opencode/context/core/workflows/task-delegation.md
|
|
.opencode/context/core/workflows/code-review.md
|
|
```
|
|
|
|
### Registry Scripts
|
|
|
|
```
|
|
scripts/registry/validate-registry.sh
|
|
scripts/registry/auto-detect-components.sh
|
|
scripts/registry/register-component.sh
|
|
scripts/registry/validate-component.sh
|
|
```
|
|
|
|
### Validation Scripts
|
|
|
|
```
|
|
scripts/validation/validate-context-refs.sh
|
|
scripts/validation/validate-test-suites.sh
|
|
scripts/validation/setup-pre-commit-hook.sh
|
|
```
|
|
|
|
### Eval Framework
|
|
|
|
```
|
|
evals/framework/src/sdk/ # Test runner
|
|
evals/framework/src/evaluators/ # Rule evaluators
|
|
evals/framework/src/collector/ # Session collection
|
|
evals/framework/src/types/ # TypeScript types
|
|
```
|
|
|
|
---
|
|
|
|
## Path Patterns
|
|
|
|
### Agents
|
|
|
|
```
|
|
.opencode/agent/{category}/{agent-name}.md
|
|
```
|
|
|
|
**Examples**:
|
|
- `.opencode/agent/core/openagent.md`
|
|
- `.opencode/agent/development/frontend-specialist.md`
|
|
- `.opencode/agent/TestEngineer.md`
|
|
|
|
### Context
|
|
|
|
```
|
|
.opencode/context/{category}/{topic}.md
|
|
```
|
|
|
|
**Examples**:
|
|
- `.opencode/context/core/standards/code-quality.md`
|
|
- `.opencode/context/development/react-patterns.md`
|
|
- `.opencode/context/content-creation/principles/copywriting-frameworks.md`
|
|
|
|
### Tests
|
|
|
|
```
|
|
evals/agents/{category}/{agent-name}/
|
|
├── config/config.yaml
|
|
└── tests/{test-name}.yaml
|
|
```
|
|
|
|
**Examples**:
|
|
- `evals/agents/core/openagent/tests/smoke-test.yaml`
|
|
- `evals/agents/development/frontend-specialist/tests/approval-gate.yaml`
|
|
|
|
### Scripts
|
|
|
|
```
|
|
scripts/{purpose}/{action}-{target}.sh
|
|
```
|
|
|
|
**Examples**:
|
|
- `scripts/registry/validate-registry.sh`
|
|
- `scripts/validation/validate-test-suites.sh`
|
|
- `scripts/versioning/bump-version.sh`
|
|
|
|
---
|
|
|
|
## Naming Conventions
|
|
|
|
### Files
|
|
|
|
- **Agents**: `{name}.md` or `{domain}-specialist.md`
|
|
- **Context**: `{topic}.md`
|
|
- **Tests**: `{test-name}.yaml`
|
|
- **Scripts**: `{action}-{target}.sh`
|
|
- **Docs**: `{topic}.md`
|
|
|
|
### Directories
|
|
|
|
- **Categories**: lowercase, singular (e.g., `development`, `content`)
|
|
- **Purposes**: lowercase, descriptive (e.g., `registry`, `validation`)
|
|
|
|
---
|
|
|
|
## Quick Lookups
|
|
|
|
### Find Agent File
|
|
|
|
```bash
|
|
# By name
|
|
find .opencode/agent -name "{agent-name}.md"
|
|
|
|
# By category
|
|
ls .opencode/agent/{category}/
|
|
|
|
# All agents
|
|
find .opencode/agent -name "*.md" -not -path "*/subagents/*"
|
|
```
|
|
|
|
### Find Test File
|
|
|
|
```bash
|
|
# By agent
|
|
ls evals/agents/{category}/{agent}/tests/
|
|
|
|
# All tests
|
|
find evals/agents -name "*.yaml"
|
|
```
|
|
|
|
### Find Context File
|
|
|
|
```bash
|
|
# By category
|
|
ls .opencode/context/{category}/
|
|
|
|
# All context
|
|
find .opencode/context -name "*.md"
|
|
```
|
|
|
|
### Find Script
|
|
|
|
```bash
|
|
# By purpose
|
|
ls scripts/{purpose}/
|
|
|
|
# All scripts
|
|
find scripts -name "*.sh"
|
|
```
|
|
|
|
---
|
|
|
|
## Related Files
|
|
|
|
- **Quick start**: `quick-start.md`
|
|
- **Categories**: `core-concepts/categories.md`
|
|
- **Commands**: `lookup/commands.md`
|
|
|
|
---
|
|
|
|
**Last Updated**: 2025-12-10
|
|
**Version**: 0.5.0
|