docs: add hierarchical AGENTS.md for hooks, tools, features

Create directory-specific knowledge bases for high-complexity directories: - src/hooks/AGENTS.md: Documents 21 hooks across 86 files - src/tools/AGENTS.md: Documents 11 LSP tools, AST-Grep, MCP, background tasks (50 files) - src/features/AGENTS.md: Documents 6 Claude Code compatibility features (24 files) Root AGENTS.md updated to reference these specialized guides while maintaining project overview. Enables better navigation and reduces cognitive load for developers working in specific areas. 🤖 Generated with assistance of OhMyOpenCode (https://github.com/code-yeongyu/oh-my-opencode)
2025-12-24 17:11:18 +09:00
parent 0172241199
commit dc9e35f18b
4 changed files with 282 additions and 74 deletions
--- a/src/features/AGENTS.md
+++ b/src/features/AGENTS.md
@@ -0,0 +1,78 @@
+# FEATURES KNOWLEDGE BASE
+
+## OVERVIEW
+
+Claude Code compatibility layer and core feature modules. Enables Claude Code configs/commands/skills/MCPs/hooks to work seamlessly in OpenCode.
+
+## STRUCTURE
+
+```
+features/
+├── background-agent/           # Background task management
+│   ├── manager.ts              # Task lifecycle, notifications
+│   ├── manager.test.ts
+│   └── types.ts
+├── claude-code-agent-loader/   # Load agents from ~/.claude/agents/*.md
+├── claude-code-command-loader/ # Load commands from ~/.claude/commands/*.md
+├── claude-code-mcp-loader/     # Load MCPs from .mcp.json
+│   └── env-expander.ts         # ${VAR} expansion
+├── claude-code-session-state/  # Session state persistence
+├── claude-code-skill-loader/   # Load skills from ~/.claude/skills/*/SKILL.md
+└── hook-message-injector/      # Inject messages into conversation
+```
+
+## LOADER PRIORITY
+
+Each loader reads from multiple directories (highest priority first):
+
+| Loader | Priority Order |
+|--------|---------------|
+| Commands | `.opencode/command/` > `~/.config/opencode/command/` > `.claude/commands/` > `~/.claude/commands/` |
+| Skills | `.claude/skills/` > `~/.claude/skills/` |
+| Agents | `.claude/agents/` > `~/.claude/agents/` |
+| MCPs | `.claude/.mcp.json` > `.mcp.json` > `~/.claude/.mcp.json` |
+
+## HOW TO ADD A LOADER
+
+1. Create directory: `src/features/claude-code-my-loader/`
+2. Create files:
+   - `loader.ts`: Main loader logic with `load()` function
+   - `types.ts`: TypeScript interfaces
+   - `index.ts`: Barrel export
+3. Pattern: Read from multiple dirs, merge with priority, return normalized config
+
+## BACKGROUND AGENT SPECIFICS
+
+- **Task lifecycle**: pending → running → completed/failed
+- **Notifications**: OS notification on task complete (configurable)
+- **Result retrieval**: `background_output` tool with task_id
+- **Cancellation**: `background_cancel` with task_id or all=true
+
+## CONFIG TOGGLES
+
+Disable features in `oh-my-opencode.json`:
+
+```json
+{
+  "claude_code": {
+    "mcp": false,      // Skip .mcp.json loading
+    "commands": false, // Skip commands/*.md loading
+    "skills": false,   // Skip skills/*/SKILL.md loading
+    "agents": false,   // Skip agents/*.md loading
+    "hooks": false     // Skip settings.json hooks
+  }
+}
+```
+
+## HOOK MESSAGE INJECTOR
+
+- **Purpose**: Inject system messages into conversation at specific points
+- **Timing**: PreToolUse, PostToolUse, UserPromptSubmit, Stop
+- **Format**: Returns `{ messages: [{ role: "user", content: "..." }] }`
+
+## ANTI-PATTERNS (FEATURES)
+
+- **Blocking on load**: Loaders run at startup, keep them fast
+- **No error handling**: Always try/catch, log failures, return empty on error
+- **Ignoring priority**: Higher priority dirs must override lower
+- **Modifying user files**: Loaders read-only, never write to ~/.claude/
--- a/src/hooks/AGENTS.md
+++ b/src/hooks/AGENTS.md
@@ -0,0 +1,83 @@
+# HOOKS KNOWLEDGE BASE
+
+## OVERVIEW
+
+Lifecycle hooks that intercept/modify agent behavior. Inject context, enforce rules, recover from errors, notify on events.
+
+## STRUCTURE
+
+```
+hooks/
+├── agent-usage-reminder/       # Remind to use specialized agents
+├── anthropic-auto-compact/     # Auto-compact Claude at token limit
+├── auto-update-checker/        # Version update notifications
+├── background-notification/    # OS notify on background task complete
+├── claude-code-hooks/          # Claude Code settings.json integration
+├── comment-checker/            # Prevent excessive AI comments
+│   ├── filters/                # Filtering rules (docstring, directive, bdd, etc.)
+│   └── output/                 # Output formatting
+├── compaction-context-injector/ # Inject context during compaction
+├── directory-agents-injector/  # Auto-inject AGENTS.md files
+├── directory-readme-injector/  # Auto-inject README.md files
+├── empty-message-sanitizer/    # Sanitize empty messages
+├── interactive-bash-session/   # Tmux session management
+├── keyword-detector/           # Detect ultrawork/search keywords
+├── non-interactive-env/        # CI/headless environment handling
+├── preemptive-compaction/      # Pre-emptive session compaction
+├── rules-injector/             # Conditional rules from .claude/rules/
+├── session-recovery/           # Recover from session errors
+├── think-mode/                 # Auto-detect thinking triggers
+├── context-window-monitor.ts   # Monitor context usage (standalone)
+├── empty-task-response-detector.ts
+├── session-notification.ts     # OS notify on idle (standalone)
+├── todo-continuation-enforcer.ts # Force TODO completion (standalone)
+└── tool-output-truncator.ts    # Truncate verbose outputs (standalone)
+```
+
+## HOOK CATEGORIES
+
+| Category | Hooks | Purpose |
+|----------|-------|---------|
+| Context Injection | directory-agents-injector, directory-readme-injector, rules-injector, compaction-context-injector | Auto-inject relevant context |
+| Session Management | session-recovery, anthropic-auto-compact, preemptive-compaction, empty-message-sanitizer | Handle session lifecycle |
+| Output Control | comment-checker, tool-output-truncator | Control agent output quality |
+| Notifications | session-notification, background-notification, auto-update-checker | OS/user notifications |
+| Behavior Enforcement | todo-continuation-enforcer, keyword-detector, think-mode, agent-usage-reminder | Enforce agent behavior |
+| Environment | non-interactive-env, interactive-bash-session, context-window-monitor | Adapt to runtime environment |
+| Compatibility | claude-code-hooks | Claude Code settings.json support |
+
+## HOW TO ADD A HOOK
+
+1. Create directory: `src/hooks/my-hook/`
+2. Create files:
+   - `index.ts`: Export `createMyHook(input: PluginInput)`
+   - `constants.ts`: Hook name constant
+   - `types.ts`: TypeScript interfaces (optional)
+   - `storage.ts`: Persistent state (optional)
+3. Return event handlers: `{ PreToolUse?, PostToolUse?, UserPromptSubmit?, Stop?, onSummarize? }`
+4. Export from `src/hooks/index.ts`
+5. Register in main plugin
+
+## HOOK EVENTS
+
+| Event | Timing | Can Block | Use Case |
+|-------|--------|-----------|----------|
+| PreToolUse | Before tool exec | Yes | Validate, modify input |
+| PostToolUse | After tool exec | No | Add context, warnings |
+| UserPromptSubmit | On user prompt | Yes | Inject messages, block |
+| Stop | Session idle | No | Inject follow-ups |
+| onSummarize | During compaction | No | Preserve critical context |
+
+## COMMON PATTERNS
+
+- **Storage**: Use `storage.ts` with JSON file for persistent state across sessions
+- **Once-per-session**: Track injected paths in Set to avoid duplicate injection
+- **Message injection**: Return `{ messages: [...] }` from event handlers
+- **Blocking**: Return `{ blocked: true, message: "reason" }` from PreToolUse
+
+## ANTI-PATTERNS (HOOKS)
+
+- **Heavy computation** in PreToolUse: Slows every tool call
+- **Blocking without clear reason**: Always provide actionable message
+- **Duplicate injection**: Track what's already injected per session
+- **Ignoring errors**: Always try/catch, log failures, don't crash session
--- a/src/tools/AGENTS.md
+++ b/src/tools/AGENTS.md
@@ -0,0 +1,73 @@
+# TOOLS KNOWLEDGE BASE
+
+## OVERVIEW
+
+Custom tools extending agent capabilities: LSP integration (11 tools), AST-aware code search/replace, file operations with timeouts, background task management.
+
+## STRUCTURE
+
+```
+tools/
+├── ast-grep/           # AST-aware code search/replace (25 languages)
+│   ├── cli.ts          # @ast-grep/cli subprocess
+│   ├── napi.ts         # @ast-grep/napi native binding (preferred)
+│   ├── constants.ts, types.ts, tools.ts, utils.ts
+├── background-task/    # Async agent task management
+├── call-omo-agent/     # Spawn explore/librarian agents
+├── glob/               # File pattern matching (timeout-safe)
+├── grep/               # Content search (timeout-safe)
+├── interactive-bash/   # Tmux session management
+├── look-at/            # Multimodal analysis (PDF, images)
+├── lsp/                # 11 LSP tools
+│   ├── client.ts       # LSP connection lifecycle
+│   ├── config.ts       # Server configurations
+│   ├── tools.ts        # Tool implementations
+│   └── types.ts
+├── slashcommand/       # Slash command execution
+└── index.ts            # builtinTools export
+```
+
+## TOOL CATEGORIES
+
+| Category | Tools | Purpose |
+|----------|-------|---------|
+| LSP | lsp_hover, lsp_goto_definition, lsp_find_references, lsp_document_symbols, lsp_workspace_symbols, lsp_diagnostics, lsp_servers, lsp_prepare_rename, lsp_rename, lsp_code_actions, lsp_code_action_resolve | IDE-like code intelligence |
+| AST | ast_grep_search, ast_grep_replace | Pattern-based code search/replace |
+| File Search | grep, glob | Content and file pattern matching |
+| Background | background_task, background_output, background_cancel | Async agent orchestration |
+| Multimodal | look_at | PDF/image analysis via Gemini |
+| Terminal | interactive_bash | Tmux session control |
+| Commands | slashcommand | Execute slash commands |
+| Agents | call_omo_agent | Spawn explore/librarian |
+
+## HOW TO ADD A TOOL
+
+1. Create directory: `src/tools/my-tool/`
+2. Create files:
+   - `constants.ts`: `TOOL_NAME`, `TOOL_DESCRIPTION`
+   - `types.ts`: Parameter/result interfaces
+   - `tools.ts`: Tool implementation (returns OpenCode tool object)
+   - `index.ts`: Barrel export
+   - `utils.ts`: Helpers (optional)
+3. Add to `builtinTools` in `src/tools/index.ts`
+
+## LSP SPECIFICS
+
+- **Client lifecycle**: Lazy init on first use, auto-shutdown on idle
+- **Config priority**: opencode.json > oh-my-opencode.json > defaults
+- **Supported servers**: typescript-language-server, pylsp, gopls, rust-analyzer, etc.
+- **Custom servers**: Add via `lsp` config in oh-my-opencode.json
+
+## AST-GREP SPECIFICS
+
+- **Meta-variables**: `$VAR` (single node), `$$$` (multiple nodes)
+- **Languages**: 25 supported (typescript, tsx, python, rust, go, etc.)
+- **Binding**: Prefers @ast-grep/napi (native), falls back to @ast-grep/cli
+- **Pattern must be valid AST**: `export async function $NAME($$$) { $$$ }` not fragments
+
+## ANTI-PATTERNS (TOOLS)
+
+- **No timeout**: Always use timeout for file operations (default 60s)
+- **Blocking main thread**: Use async/await, never sync file ops
+- **Ignoring LSP errors**: Gracefully handle server not found/crashed
+- **Raw subprocess for ast-grep**: Prefer napi binding for performance