Codewhale documentation

Find the guidance you need.

Start with the getting-started guide and installation, or go straight to vocabulary, modes, permissions, tools, providers, Fleet, hooks, MCP, and the Runtime API. These pages are the product documentation; each one cites the source documents in the repository for full detail.

Tools 工具

Curated surface — see docs/TOOL_SURFACE.md for design rationale.

read
path · offset? · limit?
write
path · content
edit
path · edits
bash
command · timeout?
Coordination
agent · tool_search (always active; every child has its own search)
Deferred
Git · Run · tasks · todo_write · remember · Web · MCP · plugins; loaded by tool_search only when policy permits
Conversation toolbox
8 names / 16 KiB of schemas; independent per child and revalidated every turn
Read-only research
Scout and Reviewer children can discover Web search/fetch without gaining mutation or arbitrary network authority
MCP
mcp_<server>_<tool> — auto-registered from ~/.codewhale/mcp.json

Replay compatibility

Legacy names remain only for saved transcripts and protocol clients. An exact old call still reaches the handler for its old schema, but stays out of new catalogs and tool_search; unknown names are never guessed or fuzzily rewritten.

docs/RUNTIME_SIMPLIFICATION_DESIGN.md →

Source documents: docs/TOOL_SURFACE.md, docs/RUNTIME_SIMPLIFICATION_DESIGN.md · Update docs-map.ts when changing.