Skip to content

vibedoc_check_docs

Lint the project's docs (.md files): broken links, stale backticked paths, unparseable frontmatter, no H1 title, empty docs, orphan docs, capability spec structure, epic `## Spec changes` that wouldn't merge, and docs that may be outdated (they name a path a done task's commits renamed or deleted; the issue names the task and the new path). Returns issues grouped by file with level (error / warn), rule and line; a clean project says so in one line. Pass `path` to check one file, e.g. after editing it, and fix its errors before marking a docs task done.

Parameters

NameTypeRequiredDescription
pathstringnoOptional: one file to check (relative to the project root)

Call it

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "vibedoc_check_docs",
    "arguments": {}
  }
}