read_outline
Get a file's symbol hierarchy (functions, classes, signatures) with configurable depth. Avoid full-file reads by returning only structural outlines from the symbol index.
Instructions
File structure: functions/classes/signatures, no full read. depth=hierarchy nesting, NOT call depth. Known symbol? read_symbol.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| file | Yes | File path relative to workspace_dir (e.g. "src/auth.py") | |
| depth | No | Hierarchy depth: 0=top-level only, 1=class+methods, 2=full recursive (default: 1) | |
| max_items | No | Max top-level items to return (default: 50) | |
| include_refs | No | Include reference counts per symbol (default: false) | |
| workspace_dir | Yes | REQUIRED: project root (abs). reindex first if new. | |
| include_test_refs | No | Include test reference counts (default: false) |