hwp_insert_heading

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

With no annotations, the description fully discloses key behaviors: automatic numbering, OutlineLevel setting, version history (level range expansion), and impact on outline view and TOC generation. It provides transparency beyond typical.

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 front-loaded with purpose and usage, followed by parameter details and version notes. It is structured but slightly lengthy; could be more concise, but the information density is high.

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 6 parameters, version history, and no output schema, the description is remarkably complete. It covers purpose, usage context, parameter details, version changes, and links to other tools (hwp_generate_toc).

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?

Though schema coverage is 100%, the description adds meaning: font sizes per level, explanation of numbering enum values, and detailed behavior of auto_outline_level and outline_level_only. This goes beyond the schema.

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 it inserts heading text (H1~H9) and specifies its use for main titles in official document numbering. It distinguishes from sibling tools by focusing on headings with numbering and outline features.

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?

It indicates usage for headings in official documents and mentions version-specific features (v0.6.9+). While it does not explicitly list alternatives or when-not-to-use, the context is clear given the sibling tools.

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