Get compact file outline
ast_get_outlineGet a type-aware outline of a TypeScript/JavaScript file's declarations, showing signatures without bodies. Optionally include symbol metadata for deeper structure.
Instructions
Returns body-free declaration signatures for one TypeScript/JavaScript file. Detailed symbol metadata is opt-in because it duplicates signature text.
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_root": "<project_root>",
"file_path": "<file_path>"
},
"name": "ast_get_outline"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| file_path | Yes | Project-relative or absolute source file path. | |
| project_root | Yes | Absolute project directory containing tsconfig.json, or the config path. | |
| include_symbols | No | Include detailed symbol metadata. Omit for the smallest body-free response. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| file | Yes | ||
| outline | Yes | ||
| symbols | No |