validate_readme_checklist
Improve README quality by validating against best practices checklist and getting detailed scoring.
Instructions
Validate README files against community best practices checklist with detailed scoring
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": {
"readmePath": "<readmePath>"
},
"name": "validate_readme_checklist"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| readmePath | Yes | Path to the README file to validate | |
| projectPath | No | Path to project directory for additional context | |
| strict | No | Use strict validation rules | |
| outputFormat | No | Output format for the validation report | console |