Agent Docs¶
Search and navigate all agent documentation: directions, system docs, capabilities, and workflows. Supports exact path lookup, subtree browsing, and natural language search with hierarchical progressive disclosure.
MCP name: agent_docs
Category: context
Parameters¶
| Name | Type | Required | Description |
|---|---|---|---|
depth |
str |
No | Content depth: 'index' (navigation), 'summary' (default), 'full' (complete) |
dev |
bool |
No | Include dev_notes in full-depth results. Auto-set when session dev mode is active. |
kind |
str |
No | Filter by kind: directions, capability, workflow, system, service, integration, reference, concept |
max_depth |
int |
No | Cap on placeholder recursion depth at depth='full'. -1 (default) = mode default (unlimited in 'default' mode, 10 in 'all' mode). 0 = no recursion (same as recursive='none' in effect). Positive ints set an exact cap. Layers with the size budget and the per-unit-occurrence cap. |
path |
str |
No | Exact unit path for direct lookup (e.g. 'journal/running-notes', 'tasks/triage') |
query |
str |
No | Natural language search. Empty + no path/scope = full index. |
recursive |
str |
No | Placeholder recursion at depth='full'. 'default' (per-placeholder --recursive flag wins), 'all' (force transitive expansion, capped at ~100KB), 'none' (preserve < |
scope |
str |
No | Path prefix to filter to a subtree (e.g. 'tasks/', 'obsidian/') |
top_n |
int |
No | Max search results (default 8) |
Details¶
Structured-result alternative — find(source="docs")¶
agent_docs returns prose-formatted results with the full unit lookup conveniences (path matching, depth filters, recursive <<wb:...>> expansion). For structured (dict-shaped) results — e.g. when chaining into walk for full-content navigation, or building UI lists — reach for find(source="docs", query="...") instead. Same backing data (the unified knowledge store); BM25 + dense ranking; structured hit list.
The docs IR source is kept fresh by the docs-index-rebuild sidecar job (every 15 minutes). Both agent_docs and find(source="docs") read from the same store; the difference is in the return shape and dispatch behaviour.