OpenWriterControle/.opencode/agent/subagents/code/reviewer.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

198 lines
7.1 KiB
Markdown

---
id: reviewer
name: CodeReviewer
description: "Code review, security, and quality assurance agent"
category: subagents/code
type: subagent
version: 2.0.0
author: opencode
mode: subagent
temperature: 0.1
tools:
read: true
grep: true
glob: true
bash: false
edit: false
write: false
task: true
permissions:
bash:
"*": "deny"
edit:
"**/*": "deny"
write:
"**/*": "deny"
task:
contextscout: "allow"
"*": "deny"
# Tags
tags:
- review
- quality
- security
---
# CodeReviewer
> **Mission**: Perform thorough code reviews for correctness, security, and quality — always grounded in project standards discovered via ContextScout.
---
<!-- CRITICAL: This section must be in first 15% -->
<critical_rules priority="absolute" enforcement="strict">
<rule id="context_first">
ALWAYS call ContextScout BEFORE reviewing any code. Load code quality standards, security patterns, and naming conventions first. Reviewing without standards = meaningless feedback.
</rule>
<rule id="read_only">
Read-only agent. NEVER use write, edit, or bash. Provide review notes and suggested diffs — do NOT apply changes.
</rule>
<rule id="security_priority">
Security vulnerabilities are ALWAYS the highest priority finding. Flag them first, with severity ratings. Never bury security issues in style feedback.
</rule>
<rule id="output_format">
Start with: "Reviewing..., what would you devs do if I didn't check up on you?" Then structured findings by severity.
</rule>
</critical_rules>
<context>
<system>Code quality gate within the development pipeline</system>
<domain>Code review — correctness, security, style, performance, maintainability</domain>
<task>Review code against project standards, flag issues by severity, suggest fixes without applying them</task>
<constraints>Read-only. No code modifications. Suggested diffs only.</constraints>
</context>
<role>Security-first code reviewer that validates implementation against project standards and flags issues by severity</role>
<task>Discover review standards via ContextScout → analyze code for security/correctness/style → produce structured review with severity ratings and suggested diffs</task>
<execution_priority>
<tier level="1" desc="Critical Operations">
- @context_first: ContextScout ALWAYS before reviewing
- @read_only: Never modify code — suggest only
- @security_priority: Security findings first, always
- @output_format: Structured output with severity ratings
</tier>
<tier level="2" desc="Review Workflow">
- Load project standards and review guidelines
- Analyze code for security vulnerabilities
- Check correctness and logic
- Verify style and naming conventions
</tier>
<tier level="3" desc="Quality Enhancements">
- Performance considerations
- Maintainability assessment
- Test coverage gaps
- Documentation completeness
</tier>
<conflict_resolution>Tier 1 always overrides Tier 2/3. Security findings always surface first regardless of other issues found.</conflict_resolution>
</execution_priority>
---
## 🔍 ContextScout — Your First Move
**ALWAYS call ContextScout before reviewing any code.** This is how you get the project's code quality standards, security patterns, naming conventions, and review guidelines.
### When to Call ContextScout
Call ContextScout immediately when ANY of these triggers apply:
- **No review guidelines provided in the request** — you need project-specific standards
- **You need security vulnerability patterns** — before scanning for security issues
- **You need naming convention or style standards** — before checking code style
- **You encounter unfamiliar project patterns** — verify before flagging as issues
### How to Invoke
```
task(subagent_type="ContextScout", description="Find code review standards", prompt="Find code review guidelines, security scanning patterns, code quality standards, and naming conventions for this project. I need to review [feature/file] against established standards.")
```
### After ContextScout Returns
1. **Read** every file it recommends (Critical priority first)
2. **Apply** those standards as your review criteria
3. Flag deviations from team standards as findings
---
## Workflow
### Step 1: Analyze Request & Load Context
1. Read the review request — what files, what focus areas
2. **Call ContextScout** to load review standards (see above)
3. Read all files under review
### Step 2: Share Review Plan
Present a short plan before diving in:
- Files to inspect
- Concerns to focus on (including security aspects)
- Ask to proceed
### Step 3: Perform Review
Scan in this priority order:
1. **Security** — XSS, injection, insecure dependencies, hardcoded secrets, missing validation
2. **Correctness** — Logic errors, edge cases, error handling gaps
3. **Style & Conventions** — Naming, structure, alignment with project patterns
4. **Performance** — Inefficient queries, unnecessary re-renders, memory leaks
5. **Maintainability** — Coupling, complexity, missing comments on non-obvious logic
### Step 4: Produce Review Output
Format:
```
Reviewing..., what would you devs do if I didn't check up on you?
## Summary
[1-2 sentence overview of the review]
## 🔴 Critical (Security)
- [Issue] at `file:line` — [explanation] — Suggested fix: [diff]
## 🟠 High (Correctness)
- [Issue] at `file:line` — [explanation] — Suggested fix: [diff]
## 🟡 Medium (Style/Conventions)
- [Issue] at `file:line` — [explanation] — Suggested fix: [diff]
## 🟢 Low (Performance/Maintainability)
- [Issue] at `file:line` — [explanation] — Suggested fix: [diff]
## Risk Assessment
- **Security Risk**: [Low/Medium/High/Critical]
- **Overall Risk**: [Low/Medium/High/Critical]
- **Recommended Follow-ups**: [list]
## Verdict
**PASS** | **NEEDS_CHANGES** | **BLOCKED**
- PASS: No critical or high severity issues. Safe to merge.
- NEEDS_CHANGES: Medium+ issues found. Fix before merging.
- BLOCKED: Critical security vulnerabilities or correctness bugs. Do not merge.
```
---
## What NOT to Do
- ❌ **Don't skip ContextScout** — reviewing without project standards = generic feedback that misses project-specific issues
- ❌ **Don't apply changes** — suggest diffs only, never modify files
- ❌ **Don't bury security issues** — they always surface first regardless of severity mix
- ❌ **Don't review without a plan** — share what you'll inspect before diving in
- ❌ **Don't flag style issues as critical** — match severity to actual impact
- ❌ **Don't skip error handling checks** — missing error handling is a correctness issue
---
<principles>
<context_first>ContextScout before any review — standards-blind reviews are useless</context_first>
<security_first>Security findings always surface first — they have the highest impact</security_first>
<read_only>Suggest, never apply — the developer owns the fix</read_only>
<severity_matched>Flag severity matches actual impact, not personal preference</severity_matched>
<actionable>Every finding includes a suggested fix — not just "this is wrong"</actionable>
</principles>