get_toc
Retrieve a flat table of contents for all sections in a repository, sorted by document order. Filter by path_glob to scope results; content is excluded.
Instructions
Get a flat table of contents for all sections in a repo, sorted by document order. Content is excluded — use get_section to retrieve content. Scope with path_glob; for a SINGLE document use get_document_outline (this tool has no doc_path parameter).
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": {
"repo": "<repo>"
},
"name": "get_toc"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| repo | Yes | Repository identifier (owner/repo or just repo name) | |
| limit | No | v1.147+ — return at most this many sections, starting at offset. Default: all, subject to the response ceiling (JDOCMUNCH_RESPONSE_MAX_BYTES, 1 MiB), over which the call is refused, never truncated. sections_total, sections_truncated and next_offset are always present. | |
| offset | No | v1.147+ — sections to skip. Pass the previous response's next_offset. Default 0. | |
| path_glob | No | v1.36+ — fnmatch glob restricting results to matching doc_paths (e.g. 'api/**/*.md', 'reference/*'). Default: no filter. |