muse_generate_dev_document
Create README, DESIGN, TUTORIAL, CHANGELOG, API, and ARCHITECTURE markdown documents with badges, API reference, FAQ, and custom sections. Supports multiple languages for documentation needs.
Instructions
Generates README, DESIGN, TUTORIAL, or CHANGELOG documents in Markdown format. Supports multiple languages, badges, API reference, FAQ, and more.
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": {
"documentType": "<documentType>"
},
"name": "muse_generate_dev_document"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| documentType | Yes | Type of document to generate (README, DESIGN, TUTORIAL, CHANGELOG, API, ARCHITECTURE) | |
| title | No | Title of the document | |
| projectName | No | Name of the project | |
| description | No | Project or document description | |
| language | No | Language for section headers (default: en) | |
| author | No | Author name | |
| version | No | Version number | |
| license | No | License type (e.g., MIT, Apache-2.0) | |
| repository | No | Repository URL | |
| badges | No | Shield.io badges | |
| features | No | List of features | |
| installation | No | Installation instructions | |
| apiReference | No | API documentation | |
| faq | No | Frequently asked questions | |
| contributors | No | List of contributors | |
| codeContexts | No | Array of code contexts to include | |
| designDecisions | No | Array of design decisions to include | |
| customSections | No | Custom sections to add (key: section title, value: content) | |
| includeTableOfContents | No | Whether to include a table of contents |