Generate report
generate_reportGenerate a markdown or JSON report that analyzes code for language-specific best practices, highlights quality and coverage gaps, and includes remediation prompts to guide improvements.
Instructions
Generate a markdown/json report with gap analysis and prompts.
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": {
"target_path": "<target_path>"
},
"name": "generate_report"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| language | No | Explicit language override. When omitted, the language is inferred from file extensions. Default to None. | |
| project_as | No | Projection-family target when ``perspective`` is ``projection``. | |
| perspective | No | Requested report perspective. Default to ``PerspectiveMode.ALL``. | all |
| target_path | Yes | Path to a single file or a directory. When a directory is given, all eligible files inside are analysed. | |
| include_gaps | No | Include quality-gap and coverage-gap summaries highlighting areas that need attention. Default to True. | |
| include_prompts | No | Append remediation prompt sections derived from ``build_prompt_bundle``. Default to False. | |
| include_analysis | No | Include the violation-analysis body showing per-rule findings. Default to True. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | Yes | ||
| markdown | Yes |