find_doc_drift
Detect documentation that no longer matches the code. Flags missing files, functions and flags, invalid code examples, failing imports, and stale sections with severity and suggested fixes.
Instructions
Documentation that no longer matches the code. Use this to check a README or docs folder, or before a release. Finds files, functions, settings and flags that don't exist; code examples that pass parameters a function doesn't take; imports that would fail; and stale sections. Each finding has a severity, cites the doc section and suggests a fix. Changelogs are skipped.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| repo | No | Name of an indexed repo, as list_repos shows it. Leave out when only one repo is indexed. | |
| limit | No | Most findings to return, 1 to 200, most severe first. | |
| path_prefix | No | Only consider files under this path, e.g. "src/auth/" or "docs/". | |
| check_history | No | Also flag doc sections last edited long before the code they describe. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| repo | Yes | ||
| summary | Yes | ||
| findings | Yes | ||
| sections_checked | Yes | ||
| references_checked | Yes |