Documentation Index
Fetch the complete documentation index at: https://mintlify.com/code-yeongyu/oh-my-opencode/llms.txt
Use this file to discover all available pages before exploring further.
Overview
Oh My OpenCode extends OpenCode with 26 specialized tools across 15 categories. Tools are registered via createToolRegistry() and follow two patterns:
- Factory functions (
createXXXTool): 19 tools that require context/dependencies
- Direct ToolDefinition: 7 tools (LSP + interactive_bash) with static definitions
Manage tasks with dependencies, metadata, and lifecycle tracking.
| Tool | Factory | Description |
|---|
task_create | createTaskCreateTool | Create new task with dependencies |
task_list | createTaskList | List all active tasks |
task_get | createTaskGetTool | Get task details by ID |
task_update | createTaskUpdateTool | Update task status/metadata |
| Tool | Description |
|---|
task | Spawn agent task with category or direct agent selection |
visual-engineering, ultrabrain, deep, artistry, quick, unspecified-low, unspecified-high, writing
See delegate-task for detailed documentation.
| Tool | Description |
|---|
call_omo_agent | Direct agent invocation without category system |
| Tool | Description |
|---|
background_output | Fetch results from running/completed background task |
background_cancel | Cancel running task(s) |
| Tool | Description |
|---|
lsp_goto_definition | Jump to symbol definition |
lsp_find_references | Find all symbol usages |
lsp_symbols | Document outline or workspace symbols |
lsp_diagnostics | Get errors/warnings before build |
lsp_prepare_rename | Validate rename operation |
lsp_rename | Safe cross-workspace rename |
| Tool | Description |
|---|
ast_grep_search | AST-aware pattern search (25 languages) |
ast_grep_replace | AST-aware code rewriting |
grep | Regex content search (60s timeout, 10MB limit) |
glob | File pattern matching (60s timeout, 100 file limit) |
Session History (4 tools)
Query and navigate conversation history.
| Tool | Description |
|---|
session_list | List all sessions |
session_read | Read session messages |
session_search | Search session content |
session_info | Get session metadata |
| Tool | Description |
|---|
skill | Load built-in skill by name |
skill_mcp | Invoke MCP tool/resource/prompt |
| Tool | Description |
|---|
interactive_bash | Interactive tmux session management |
look_at | Vision model analysis of images/screenshots |
| Tool | Description |
|---|
hashline_edit | Safe file editing using LINE#ID validation |
src/plugin/tool-registry.ts:
import { createToolRegistry } from "@opencode-ai/plugin"
import { builtinTools } from "../tools"
import { createHashlineEditTool } from "../tools/hashline-edit"
import { createAstGrepTools } from "../tools/ast-grep"
export function createTools(ctx: PluginInput): Record<string, ToolDefinition> {
return {
...builtinTools,
hashline_edit: createHashlineEditTool(),
...createAstGrepTools(ctx),
...createBackgroundTools(manager, client),
task: createDelegateTask(options),
// ... other tools
}
}
- Create
src/tools/{name}/index.ts exporting factory
- Create
src/tools/{name}/types.ts for parameter schemas
- Create
src/tools/{name}/tools.ts for implementation
- Register in
src/plugin/tool-registry.ts
Example Structure
// src/tools/my-tool/tools.ts
import { tool, type ToolDefinition } from "@opencode-ai/plugin/tool"
export function createMyTool(): ToolDefinition {
return tool({
description: "What this tool does",
args: {
param1: tool.schema.string().describe("Parameter description"),
param2: tool.schema.number().optional(),
},
execute: async (args, context) => {
// Implementation
return "result"
},
})
}
tool.execute.before hooks
↓
Tool execution
↓
tool.execute.after hooks
Available Hooks
Before Hooks: commentChecker, rulesInjector, writeExistingFileGuard, hashlineReadEnhancer
After Hooks: outputTruncation, metadataStore, labelTruncator
See /api/hooks for hook documentation.
Configuration
Tools can be disabled via config:
// .opencode/oh-my-opencode.jsonc
{
"disabled_tools": ["hashline_edit", "lsp_rename"]
}
Source Location
All tool implementations: ~/workspace/source/src/tools/
- Each tool has its own directory
- Common pattern:
index.ts (exports), tools.ts (implementation), types.ts (schemas)
- Test files co-located:
*.test.ts