Generate README
generate_readmeEnsure README accuracy by generating a professional, fact-based README.md from your codebase's source, dependencies, and git history.
Instructions
Generate a professional README.md grounded in the real project (source, dependencies, git history, env vars, existing docs). Overview/Features/Usage/Troubleshooting are narrated but every claim traces to a fact; Installation/Configuration/Contributing/License are generated deterministically from facts alone.
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": "generate_readme"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| projectPath | Yes |