generate_api_reference
Create API reference documentation from code annotations, JSDoc, docstrings, and type definitions to maintain synchronized documentation across programming languages.
Instructions
Generate API reference documentation from code annotations, JSDoc, docstrings, and type definitions
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": {
"source_path": "<source_path>"
},
"name": "generate_api_reference"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| source_path | Yes | Path to source code for API extraction | |
| output_path | No | Output path for API reference | |
| format | No | Output format | mintlify |
| include_private | No | Include private/internal APIs |