obsidian_outline
Get a note's heading outline by file name or exact path. Choose tree, markdown, or JSON output, or request only the heading count.
Instructions
List the heading outline of a note, selecting it by file name or exact path.
Wraps the CLI's outline Verb. Provide one of file or path. Optional format controls the output shape; optional total returns just the heading count.
Parameters: file (optional) — note name using wikilink resolution (e.g. 'My Note') path (optional) — exact vault-relative path (e.g. 'folder/My Note.md') format (optional) — output format: 'tree' (default), 'md', or 'json' total (optional) — true to return the heading count instead of the outline One of file or path is required.
Examples: obsidian_outline({ file: "Meeting Notes" }) obsidian_outline({ path: "Projects/plan.md", format: "json" }) obsidian_outline({ file: "Long Doc", total: true })
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "obsidian_outline"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| file | No | File name (wikilink resolution) | |
| path | No | Exact file path | |
| total | No | Return heading count instead of the outline | |
| format | No | Output format (default: tree) |