Tools
outline
Inspect the API or document structure of known files.
Use outline when you know file paths and need their structural API or document organization without reading full bodies.
Use when
- You need declarations, signatures, hierarchy, fields, methods, or imports.
- You need headings and sections from a document.
Do not use when
- You do not know the file; discover it with
grep_definition. - You need implementation text; use
extractwith a returned handle.
Request
{"files":["/workspace/project/src/lib.rs","/workspace/project/src/api.rs"],"workspace_root":"/workspace/project"}Parameters
| Field | Required | Default / bounds |
|---|---|---|
files | yes | One or more paths; file_paths is accepted as an alias. |
workspace_root | no | Active workspace routing. |
What it returns
Each file's structural outline: declarations, signatures, types, hierarchy, and imports for source; headings and sections for documents. If the outline answers the question, avoid a costly body read. Otherwise pass only relevant handles to extract.
Common mistakes
- Passing a directory instead of a file path.
- Reading full implementations when the outline is sufficient.
- Using a dependency path without first resolving a visible dependency symbol with
jump.
Related tools
grep_definition, extract, line_context, smart_read