insert_header_near_text

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. It fails to mention what happens when both target_text and target_paragraph_index are provided, whether it can replace existing headings, or any side effects. The description is too brief to be transparent.

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?

While the description is one sentence, it is under-specified rather than concise. Important details are omitted, so it does not earn its place. A better structure would front-load the purpose and then provide more context.

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?

With 6 parameters, no output schema, and no schema descriptions, this description is completely inadequate. It does not explain return values, the meaning of 'near', or how to properly use the parameters. The tool cannot be used correctly with this description alone.

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 0%, so the description must explain parameter meanings. It only mentions 'found text' and 'paragraph index', but does not explain header_title, position (e.g., 'after' vs 'before'), level (heading levels), or how target_paragraph_index works. Users are left guessing.

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 states the action ('insert a heading') and the context ('near the found text or paragraph index'). It clearly distinguishes from sibling 'add_heading' which likely inserts at an absolute position. However, 'near' is vague and could be more precise.

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 on when to use this tool versus alternatives like 'add_heading', 'insert_html_at_paragraph', or other insertion tools. The description does not provide any when-to-use or when-not-to-use information.

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