add_heading

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

The description discloses the basic behavior (adds a heading) and return type, but lacks details about side effects, insertion position, or error conditions. Since no annotations are provided, the description carries full burden and only meets the minimum.

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?

Extremely concise with a clear header, bulleted args, and returns section. Every sentence is necessary and front-loaded.

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?

Lacks critical context such as the need for an open document, possible errors, or behavior with existing content. Despite the output schema existing, the description only states 'Success message or error', which is insufficient for a complete picture.

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?

Adds minimal meaning beyond the input schema: explains level as '0-9, where 0 is Title' and text as 'Heading text'. With 0% schema description coverage, the description provides some but not extensive parameter context.

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?

Clearly states the action ('Add a heading to the current document') with specific verb and resource. However, it does not differentiate from sibling tools like add_paragraph or add_numbered_list, which might also be used for heading-like content.

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?

The description provides no guidance on when to use this tool versus alternatives. There is no mention of prerequisites, context, or criteria for choosing add_heading over other add_* tools.

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