get_document_outline
Extract a compact structural outline of DOCX headings as JSON or Markdown, including numbered labels and optional heuristic headings, to quickly understand document structure.
Instructions
Get a compact structural map of a document's headings (DOCX only). Each entry is {paragraph_id, text, level, source}, plus list_label (e.g. "Section 1.01") when the heading is numbered; Markdown puts the label before the text. Deterministic sources are word_style, list_metadata, and outline_level, selected in that precedence order and included by default. Heuristic sources are run_in_header, title_with_period, title_with_colon, title_caps_centered, and title_bare; set include_heuristic_headings=true to include them. JSON preserves levels 1-9; Markdown clamps visual ATX depth to 6. Read-only.
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": "get_document_outline"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| format | No | Output format: 'json' (default, structured outline array) or 'markdown' (indented ATX outline under `content`). | |
| file_path | No | Path to the DOCX file. | |
| include_heuristic_headings | No | When true, also include heuristic title/run-in/centered-caps headings alongside deterministic word_style, list_metadata, and outline_level headings. Default: false (all deterministic sources only). |