OpenWriterControle/.opencode/command/openagents/check-context-deps.md
Darren Hinde 193271091a
feat: add ExternalScout and optimize ContextScout with research-backed patterns (#128)
* 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
2026-01-29 11:16:12 +00:00

433 lines
12 KiB
Markdown

---
description: Validate context file dependencies across agents and registry
tags:
- registry
- validation
- context
- dependencies
- openagents
dependencies:
- command:analyze-patterns
---
# Check Context Dependencies
**Purpose**: Ensure agents properly declare their context file dependencies in frontmatter and registry.
**Arguments**: `$ARGUMENTS`
---
## What It Does
Validates consistency between:
1. **Actual usage** - Context files referenced in agent prompts
2. **Declared dependencies** - Dependencies in agent frontmatter
3. **Registry entries** - Dependencies in registry.json
**Identifies**:
- ✅ Missing dependency declarations (agents use context but don't declare it)
- ✅ Unused context files (exist but no agent references them)
- ✅ Broken references (referenced but don't exist)
- ✅ Format inconsistencies (wrong dependency format)
---
## Usage
```bash
# Analyze all agents
/check-context-deps
# Analyze specific agent
/check-context-deps contextscout
# Auto-fix missing dependencies
/check-context-deps --fix
# Verbose output (show all reference locations)
/check-context-deps --verbose
# Combine flags
/check-context-deps contextscout --verbose
```
---
## Workflow
<workflow id="analyze_context_dependencies">
<stage id="1" name="ScanAgents" required="true">
Scan agent files for context references:
**Search patterns**:
- `.opencode/context/` (direct path references)
- `@.opencode/context/` (@ symbol references)
- `context:` (dependency declarations in frontmatter)
**Locations**:
- `.opencode/agent/**/*.md` (all agents and subagents)
- `.opencode/command/**/*.md` (commands that use context)
**Extract**:
- Agent/command ID
- Context file path
- Line number
- Reference type (path, @-reference, dependency)
</stage>
<stage id="2" name="CheckRegistry" required="true">
For each agent found, check registry.json:
```bash
jq '.components.agents[] | select(.id == "AGENT_ID") | .dependencies' registry.json
jq '.components.subagents[] | select(.id == "AGENT_ID") | .dependencies' registry.json
```
**Verify**:
- Does the agent have a dependencies array?
- Are context file references declared as `context:core/standards/code`?
- Are the dependency formats correct (`context:path/to/file`)?
</stage>
<stage id="3" name="ValidateContextFiles" required="true">
For each context file referenced:
**Check existence**:
```bash
test -f .opencode/context/core/standards/code-quality.md
```
**Check registry**:
```bash
jq '.components.contexts[] | select(.id == "core/standards/code")' registry.json
```
**Identify issues**:
- Context file referenced but doesn't exist
- Context file exists but not in registry
- Context file in registry but never used
</stage>
<stage id="4" name="Report" required="true">
Generate comprehensive report:
```markdown
# Context Dependency Analysis Report
## Summary
- Agents scanned: 25
- Context files referenced: 12
- Missing dependencies: 8
- Unused context files: 2
- Missing context files: 0
## Missing Dependencies (agents using context but not declaring)
### opencoder
**Uses but not declared**:
- context:core/standards/code (referenced 3 times)
- Line 64: "Code tasks → .opencode/context/core/standards/code-quality.md (MANDATORY)"
- Line 170: "Read .opencode/context/core/standards/code-quality.md NOW"
- Line 229: "NEVER execute write/edit without loading required context first"
**Current dependencies**: subagent:task-manager, subagent:coder-agent
**Recommended fix**: Add to frontmatter:
```yaml
dependencies:
- subagent:task-manager
- subagent:coder-agent
- context:core/standards/code # ADD THIS
```
### openagent
**Uses but not declared**:
- context:core/standards/code (referenced 5 times)
- context:core/standards/docs (referenced 3 times)
- context:core/standards/tests (referenced 3 times)
- context:core/workflows/review (referenced 2 times)
- context:core/workflows/delegation (referenced 4 times)
**Recommended fix**: Add to frontmatter:
```yaml
dependencies:
- subagent:task-manager
- subagent:documentation
- context:core/standards/code
- context:core/standards/docs
- context:core/standards/tests
- context:core/workflows/review
- context:core/workflows/delegation
```
## Unused Context Files (exist but no agent references them)
- context:core/standards/analysis (0 references)
- context:core/workflows/sessions (0 references)
**Recommendation**: Consider removing or documenting intended use
## Missing Context Files (referenced but don't exist)
None found ✅
## Context File Usage Map
| Context File | Used By | Reference Count |
|--------------|---------|-----------------|
| core/standards/code | opencoder, openagent, frontend-specialist, reviewer | 15 |
| core/standards/docs | openagent, documentation, technical-writer | 8 |
| core/standards/tests | openagent, tester | 6 |
| core/workflows/delegation | openagent, task-manager | 5 |
| core/workflows/review | openagent, reviewer | 4 |
---
## Next Steps
1. Review missing dependencies above
2. Run `/check-context-deps --fix` to auto-update frontmatter
3. Run `./scripts/registry/auto-detect-components.sh` to update registry
4. Verify with `./scripts/registry/validate-registry.sh`
```
</stage>
<stage id="5" name="Fix" when="--fix flag provided">
For each agent with missing context dependencies:
1. Read the agent file
2. Parse frontmatter YAML
3. Add missing context dependencies to dependencies array
4. Preserve existing dependencies
5. Write updated file
6. Report what was changed
**Example**:
```diff
---
id: opencoder
dependencies:
- subagent:task-manager
- subagent:coder-agent
+ - context:core/standards/code
---
```
**Safety**:
- Only add dependencies that are actually referenced in the file
- Don't remove existing dependencies
- Preserve frontmatter formatting
- Show diff before applying (if interactive)
</stage>
</workflow>
---
## Implementation Details
### Search Patterns
**Find direct path references**:
```bash
grep -rn "\.opencode/context/" .opencode/agent/ .opencode/command/
```
**Find @ references**:
```bash
grep -rn "@\.opencode/context/" .opencode/agent/ .opencode/command/
```
**Find dependency declarations**:
```bash
grep -rn "^\s*-\s*context:" .opencode/agent/ .opencode/command/
```
### Path Normalization
**Convert to dependency format**:
- `.opencode/context/core/standards/code-quality.md` → `context:core/standards/code`
- `@.opencode/context/openagents-repo/quick-start.md` → `context:openagents-repo/quick-start`
- `context/core/standards/code` → `context:core/standards/code`
**Rules**:
1. Strip `.opencode/` prefix
2. Strip `.md` extension
3. Add `context:` prefix for dependencies
### Registry Lookup
**Check if context file is in registry**:
```bash
jq '.components.contexts[] | select(.id == "core/standards/code")' registry.json
```
**Get agent dependencies**:
```bash
jq '.components.agents[] | select(.id == "opencoder") | .dependencies[]?' registry.json
```
---
## Delegation
This command delegates to an analysis agent to perform the work:
```javascript
task(
subagent_type="PatternAnalyst",
description="Analyze context dependencies",
prompt=`
Analyze context file usage across all agents in this repository.
TASK:
1. Use grep to find all references to context files in:
- .opencode/agent/**/*.md
- .opencode/prompts/**/*.md
2. Search for these patterns:
- ".opencode/context/core/" (direct paths)
- "@.opencode/context/" (@ references)
- "context:" in frontmatter (dependency declarations)
3. For each agent file found:
- Extract agent ID from frontmatter
- List all context files it references
- Check registry.json for declared dependencies
- Identify missing dependency declarations
4. For each context file in .opencode/context/core/:
- Count how many agents reference it
- Check if it exists in registry.json
- Identify unused context files
5. Generate a comprehensive report showing:
- Agents with missing context dependencies
- Unused context files
- Missing context files (referenced but don't exist)
- Context file usage map (which agents use which files)
${ARGUMENTS.includes('--fix') ? `
6. AUTO-FIX MODE:
- Update agent frontmatter to add missing context dependencies
- Use format: context:core/standards/code
- Preserve existing dependencies
- Show what was changed
` : ''}
${ARGUMENTS.includes('--verbose') ? `
VERBOSE MODE: Include all reference locations (file:line) in report
` : ''}
${ARGUMENTS.length > 0 && !ARGUMENTS.includes('--') ? `
FILTER: Only analyze agent: ${ARGUMENTS[0]}
` : ''}
REPORT FORMAT:
- Summary statistics
- Missing dependencies by agent (with recommended fixes)
- Unused context files
- Context file usage map
- Next steps
DO NOT make changes without --fix flag.
ALWAYS show what would be changed before applying fixes.
`
)
```
---
## Examples
### Example 1: Basic Analysis
```bash
/check-context-deps
```
**Output**:
```
Analyzing context file usage across 25 agents...
Found 8 agents with missing context dependencies:
- opencoder: missing context:core/standards/code
- openagent: missing 5 context dependencies
- frontend-specialist: missing context:core/standards/code
...
Run /check-context-deps --fix to auto-update frontmatter
```
### Example 2: Analyze Specific Agent
```bash
/check-context-deps contextscout
```
**Output**:
```
Analyzing agent: contextscout
Context files referenced:
✓ .opencode/context/core/context-system.md (1 reference)
- Line 15: "Load: context:core/context-system"
✓ .opencode/context/core/context-system/standards/mvi.md (2 references)
- Line 16: "Load: context:core/context-system/standards/mvi"
- Line 89: "MVI-aware prioritization"
Registry dependencies:
✓ context:core/context-system DECLARED
✓ context:core/context-system/standards/mvi DECLARED
All dependencies properly declared ✅
```
### Example 3: Auto-Fix
```bash
/check-context-deps --fix
```
**Output**:
```
Analyzing and fixing context dependencies...
Updated opencoder:
+ Added: context:core/standards/code
Updated openagent:
+ Added: context:core/standards/code
+ Added: context:core/standards/docs
+ Added: context:core/standards/tests
+ Added: context:core/workflows/review
+ Added: context:core/workflows/delegation
Total: 2 agents updated, 6 dependencies added
Next: Run ./scripts/registry/auto-detect-components.sh to update registry
```
---
## Success Criteria
✅ All agents that reference context files have them declared in dependencies
✅ All context files in registry are actually used by at least one agent
✅ No broken references (context files referenced but don't exist)
✅ Dependency format is consistent (`context:path/to/file`)
---
## Notes
- **Read-only by default** - Only reports findings, doesn't modify files
- **Use `--fix` to update** - Auto-adds missing dependencies to frontmatter
- **After fixing** - Run `./scripts/registry/auto-detect-components.sh --auto-add` to sync registry
- **Dependency format** - `context:path/to/file` (no `.opencode/` prefix, no `.md` extension)
- **Scans both** - Direct path references and @ references
## Related
- **Registry validation**: `./scripts/registry/validate-registry.sh`
- **Auto-detect components**: `./scripts/registry/auto-detect-components.sh`
- **Context guide**: `.opencode/context/openagents-repo/quality/registry-dependencies.md`