get_document_outline

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

The description states that the tool returns a 'hierarchical view of all headings' and mentions that it could return an error. However, without annotations, it does not disclose potential side effects, performance implications, or document requirements (e.g., must have headings).

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

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

The description is extremely concise—three short lines—with no wasted words. The main purpose is stated immediately, and the return type is mentioned. It is well-structured for quick AI parsing.

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

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

Given the tool has no parameters and no annotations, the description covers the core behavior. However, it could be more complete by clarifying that the outline is derived from headings in the current document, and how it differs from 'get_document_structure.'

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

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

There are no parameters, so schema coverage is 100%. The description adds no parameter details because none exist, but the baseline for 0 parameters is 4, and no improvement is needed.

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

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

The description specifies 'Get the document outline based on headings' and 'hierarchical view of all headings,' clearly indicating the tool's function. It distinguishes from siblings like 'get_document_structure' by focusing solely on headings, but could be more explicit about the differentiation.

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

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

No guidance is provided on when to use this tool versus alternatives such as 'get_document_structure' or 'get_document_info.' There are no prerequisites or context about the document state needed.

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