generate_readme_template
Generate standardized README templates for libraries, applications, CLIs, APIs, or documentation projects with best practices included.
Instructions
Generate standardized README templates for different project types with best practices
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": {
"projectName": "<projectName>",
"description": "<description>",
"templateType": "<templateType>"
},
"name": "generate_readme_template"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| projectName | Yes | Name of the project | |
| description | Yes | Brief description of what the project does | |
| templateType | Yes | Type of project template to generate | |
| author | No | Project author/organization name | |
| license | No | Project license | MIT |
| includeScreenshots | No | Include screenshot placeholders for applications | |
| includeBadges | No | Include status badges | |
| includeContributing | No | Include contributing section | |
| outputPath | No | Path to write the generated README.md file |