generate_readme
Builds a README.md for a project using standard sections: description, features, installation, usage, dependencies, configuration, tech stack, and more. Specify a project path and optional details.
Instructions
(Re)generate README.md for a project with the standard sections: description, features, folder structure, installation, usage, dependencies, configuration, tech stack, future improvements, license.
Args: project_path: Path to the project directory, relative to the workspace root.
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_path": "<project_path>"
},
"name": "generate_readme"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| usage | No | ||
| features | No | ||
| tech_stack | No | ||
| description | No | ||
| dependencies | No | ||
| installation | No | ||
| license_name | No | MIT | |
| project_path | Yes | ||
| configuration | No | ||
| future_improvements | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||