get_document_outline
Lists a document's pages with masked first lines so you can identify which forms and worksheets it contains and their order; locked documents are reported, not opened.
Instructions
A document's pages, each with its first lines masked: which forms and worksheets it holds, and in what order. A password-protected document is reported as locked, not opened (taxtrace's own commands read it with a password from the Keychain). To see how the forms in it checked out use get_form_checks; to find the id, list_documents.
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": {
"id": "<id>"
},
"name": "get_document_outline"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The document's id from list_documents (its place in the workspace, from 1). Ids change when documents are added or removed, so list again after an import. | |
| limit | No | How many pages to list from start (default 40, at most 200). | |
| lines | No | How many of each page's first lines to show, masked (default 2: on a tax form they name the form). | |
| start | No | The first page to list (default 1). |