Review Documentation
review_documentationAssess hand-written docs for coverage, quality, and consistency (0-100 each) and receive missing sections and actionable recommendations. Works standalone.
Instructions
Score a project's existing documentation on coverage/quality/consistency (0-100 each, computed deterministically from headings/word counts/topic coverage) and list missing sections and recommendations. Works against hand-written docs alone — no other generator tool needs to have run first.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"projectPath": "<projectPath>"
},
"name": "review_documentation"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| projectPath | Yes |