|
| 1 | +# Agent instructions |
| 2 | + |
| 3 | +## When to Use What |
| 4 | + |
| 5 | +| Your Need | Skill | Example Trigger | |
| 6 | +|-----------------------------------------------|--------------------------|---------------------------------------------------------------| |
| 7 | +| Local code search, structure, definitions | **Local Search** | "Find X in codebase", "Where is Y?", "Explore this dir" | |
| 8 | +| Full research (local + GitHub, PRs, packages) | **Research** | "How does X work?", "Who calls Z?", "Trace flow", "Review PR" | |
| 9 | +| Plan work before implementing | **Plan** | "Plan this feature", "Research & plan refactor" | |
| 10 | +| Review a pull request | **PR Reviewer** | "Review PR #123", "Is this PR safe to merge?" | |
| 11 | +| Brutal code criticism with fixes | **Roast** | "Roast my code", "Find code sins", "What's wrong with this?" | |
| 12 | +| Strengthen prompts / agent instructions | **Prompt Optimizer** | "Optimize this SKILL.md", "Agent skips steps" | |
| 13 | +| Generate repo documentation | **Documentation Writer** | "Document this project", "Create developer docs" | |
| 14 | + |
| 15 | +--- |
| 16 | + |
| 17 | +## Skills Overview |
| 18 | + |
| 19 | +### 1. OctoCode Local Search |
| 20 | + |
| 21 | +**Location:** `octocode-local-search/` |
| 22 | + |
| 23 | +Local codebase exploration using Octocode Local + LSP. Search, structure, find files, trace definitions/usages—no GitHub. Fast local discovery. |
| 24 | + |
| 25 | +| When | Example | |
| 26 | +|-------------------|------------------------------------------| |
| 27 | +| Local search only | "Find auth logic", "Where is X defined?" | |
| 28 | +| Explore structure | "List src/ files", "Show package layout" | |
| 29 | + |
| 30 | +--- |
| 31 | + |
| 32 | +### 2. OctoCode Research |
| 33 | + |
| 34 | +**Location:** `octocode-research/` |
| 35 | + |
| 36 | +Deep code exploration: LSP, local tools, GitHub API, packages, PRs. File:line citations and GitHub URLs. Full stack research. |
| 37 | + |
| 38 | +| When | Example | |
| 39 | +|-----------------|-------------------------------------------------------| |
| 40 | +| Research code | "Research how auth works" | |
| 41 | +| GitHub/external | "How does library X work?", "Find PRs that changed Y" | |
| 42 | + |
| 43 | +--- |
| 44 | + |
| 45 | +### 3. OctoCode Plan |
| 46 | + |
| 47 | +**Location:** `octocode-plan/` |
| 48 | + |
| 49 | +Evidence-based planning. Understand → Research (via Local Search/Research) → Plan → Implement. No guessing; validates with code. |
| 50 | + |
| 51 | +| When | Example | |
| 52 | +|-------------------|-------------------------------------------------------| |
| 53 | +| Multi-step work | "Plan auth refactor", "Plan API v2" | |
| 54 | +| Non-trivial tasks | "Research & plan this feature" | |
| 55 | + |
| 56 | +--- |
| 57 | + |
| 58 | +### 4. OctoCode Prompt Optimizer |
| 59 | + |
| 60 | +**Location:** `octocode-prompt-optimizer/` |
| 61 | + |
| 62 | +Turns weak prompts into enforceable protocols. Gates, FORBIDDEN lists, failure analysis. Preserves intent, adds reliability. |
| 63 | + |
| 64 | +| When | Example | |
| 65 | +|-------------------|-------------------------------------------------------| |
| 66 | +| Prompts ignored | "Agent keeps skipping steps" | |
| 67 | +| New/weak instructions | "Optimize this SKILL.md", "Make prompt reliable" | |
| 68 | + |
| 69 | +*Not for:* Short prompts (<50 lines), already-optimized docs. |
| 70 | + |
| 71 | +--- |
| 72 | + |
| 73 | +### 5. OctoCode Documentation Writer |
| 74 | +**Location:** `octocode-documentation-writer/` |
| 75 | + |
| 76 | +6-phase pipeline: Discovery → Questions → Research → Orchestration → Writing → QA. Produces 16+ docs with validation. |
| 77 | + |
| 78 | +| When | Example | |
| 79 | +|-------------------|-----------------------------------------| |
| 80 | +| New/outdated docs | "Generate documentation", "Update docs" | |
| 81 | +| Onboarding | "Create docs for new devs" | |
| 82 | + |
| 83 | +--- |
| 84 | + |
| 85 | +### 6. OctoCode Roast |
| 86 | + |
| 87 | +**Location:** `octocode-roast/` |
| 88 | + |
| 89 | +Brutal code critique with file:line citations. Severity: gentle → nuclear. Sin registry, user picks fixes. Cites or dies. |
| 90 | + |
| 91 | +| When | Example | |
| 92 | +|-----------------|--------------------------------------| |
| 93 | +| Code critique | "Roast my code", "Find antipatterns" | |
| 94 | +| Honest feedback | "What's wrong with my code?" | |
| 95 | + |
| 96 | +--- |
| 97 | + |
| 98 | +### 7. OctoCode Pull Request Reviewer |
| 99 | + |
| 100 | +**Location:** `octocode-pull-request-reviewer/` |
| 101 | + |
| 102 | +Holistic PR review via Octocode MCP: bugs, security, architecture, flow impact. 7 domains, evidence-backed, user checkpoint before deep dive. |
| 103 | + |
| 104 | +| When | Example | |
| 105 | +|-----------------|-----------------------------------| |
| 106 | +| PR review | "Review PR #456", "Check this PR" | |
| 107 | +| Security/impact | "Is this safe to merge?" | |
0 commit comments