word_set_headings

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

No annotations are provided, so the description carries the full burden. It states the action 'set or clear' but doesn't disclose side effects such as modifying the .docx file, potential to overwrite existing heading styles, or any permission requirements. This is a mutation tool with inadequate behavioral disclosure.

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 a single concise sentence that is front-loaded with the action and object. Every word contributes to meaning, making it highly scannable.

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?

The tool is relatively simple with 2 well-documented parameters and no output schema. However, the lack of usage guidelines and behavioral transparency means the agent might not know when to call this or what happens after execution. It's minimally viable but has clear gaps.

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?

Schema description coverage is 100% with both file_path and edits documented, and nested items (para_id, level) also have descriptions. The description adds little beyond the schema, mainly repeating 'by paraId' and mentioning the set/clear behavior which aligns with the level parameter's '0 to clear'.

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 uses a specific verb phrase 'Set or clear' and identifies the resource 'heading style on paragraphs' with the key 'paraId'. This clearly distinguishes it from sibling tools like word_set_paragraph_formats which handle broader paragraph formatting.

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 implies usage for heading formatting but provides no explicit guidance on when to use this tool versus alternatives like word_set_paragraph_formats or word_edit_paragraphs. There are no exclusions or alternative recommendations.

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