Skip to content
VibeDocVibeDoc docs

vibedoc_read_doc

Read a doc file by name. Starts with one `> path · priority · last edit · inbound links` line (off with `docs.agentHeader: false` in .vibedoc/settings.json); a wrong name lists up to 5 similar docs. Use: "CLAUDE", "HLD", "EVENT_CATALOG", "MEMORY", "user-service/API", "ADR-001". Ends with a "## Related files" footer when the doc has links: what it links to, what links to it (docs by path; tasks, epics, entries, ADRs by id) broken links ([x](y.md) / [[y]] to no file) and stale paths (backticked paths to missing files), so you know what to read next. You get the agent view: `<!-- agent-only … -->` notes are shown, `<!-- human-only:start/end -->` blocks are removed (so an edit can't match text inside them).

Parameters

NameTypeRequiredDescription
querystringyesDoc name, e.g. "CLAUDE", "HLD", "user-service/API"

Call it

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "vibedoc_read_doc",
    "arguments": {
      "query": "<string>"
    }
  }
}