readme_generate
Generate a comprehensive README.md from project source code and configuration. Provide project name and source summary to get structured documentation ready for use.
Instructions
Generate a comprehensive README.md from project source code and configuration
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": {
"project_name": "<project_name>",
"source_summary": "<source_summary>"
},
"name": "readme_generate"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| api_key | No | API key for authentication | |
| language | No | Primary programming language | |
| project_name | Yes | Name of the project | |
| source_summary | Yes | Summary of project source code, structure, and purpose |