get_headings

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

With no annotations provided, the description carries full burden for behavioral disclosure. It describes the output structure but does not explicitly state the tool is read-only or non-destructive, nor does it mention any permissions or side effects. The name implies a safe read operation, but explicit disclosure is absent.

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 at two sentences. The first sentence states the purpose, and the second lists the output fields. No extraneous information, and it is well-structured for quick understanding.

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's simplicity and the existence of an output schema, the description covers purpose and output format. However, it lacks parameter explanation and usage guidance. For a straightforward read tool, this is moderately complete but missing key context for correct invocation.

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?

The only parameter, 'document_handle', has zero schema description coverage and is not mentioned in the tool description. The description fails to clarify what this parameter represents or how to use it, leaving the agent to guess. Since the tool likely operates on a current document or requires an identifier, this omission is a significant gap.

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 clearly states the tool's purpose: 'Get the document heading structure with levels, text, and paraIds.' It specifies what each entry contains, distinguishing it from sibling tools like get_all_paragraphs or get_body_text by focusing specifically on headings.

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 like get_document_outline or get_all_paragraphs. The description does not mention prerequisites, context, or exclusions, leaving the agent to infer usage from the name alone.

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