Skip to main content
Glama

get_outline

Retrieves outline entries under a specified section of a document, with page numbers, to drill into large documents when the top-level index is insufficient.

Instructions

The outline entries under one section of a document, with pages. Use it for a large document, when get_index gives only the top levels.

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": {
      "document": "<document>",
      "section": "<section>"
    },
    "name": "get_outline"
  }
}

Input Schema

NameRequiredDescriptionDefault
sectionYesA section number, for example "8.27", or the title of an outline entry as get_index gives it (a document with no section numbers).
documentYesThe document: its reference from list_documents, project_status or add_document (the first 12 characters of its SHA-256). A longer SHA-256 prefix or the numeric document ID also works.

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.5.0
    • changedInput schema / properties / section / description
      Previous value: -"A section number, for example \"8.27\"."New value: +"A section number, for example \"8.27\", or the title of an outline entry as get_index gives it (a document with no section numbers)."
  2. First observedv0.1.0

TDQS

A3.6/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are supplied, so the description carries the burden, and it does disclose that results include page numbers and that this tool drills deeper than get_index. It leaves the read-only, non-destructive nature and the failure behavior for an unknown section implicit. With an output schema present, the return shape itself need not be restated.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two compact sentences, with the what front-loaded and the when second. No filler or repetition of schema fields. The line break mid-sentence is a minor formatting blemish, not a comprehension problem.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

A two-parameter read tool with a full schema and an output schema needs little more than scope and selection guidance, both of which are present. Nothing essential is missing, though a note on what happens when the section is not found would close the last gap.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, including the exact section-number format and the accepted document reference forms, so the schema does the heavy lifting. The description only reinforces that 'section' scopes the outline. Baseline 3 applies since it adds little beyond the schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States the resource precisely: outline entries under one section of a document, plus the fact that page numbers come with them. It names the sibling get_index and contrasts its depth, so an agent can distinguish the two without opening either schema. It is phrased as a noun fragment rather than a verb+resource statement, which keeps it just short of top marks.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives an explicit selection condition: use this for a large document when get_index only surfaces the top levels. That is real when-to-use guidance tied to the alternative. It does not state the converse (when get_index alone suffices), but the condition given is sufficient to route correctly.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.