insert_paragraph_after

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

No annotations exist, so the description must fully disclose behavior. It mentions insertion but lacks details on side effects (e.g., shifting indices, file saving) or error handling. The operational impact is not clearly communicated.

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 concise, listing parameters with explanations in a structured format. It front-loads the purpose. However, the line-by-line list could be more streamlined for an agent, but it is not overly verbose.

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 complexity (9 parameters, write operation) and the existence of an output schema, the description covers parameter semantics but misses error conditions, prerequisites, and context relative to sibling tools. It is adequate but not comprehensive.

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?

With 0% schema description coverage, the description adds significant value by explaining each parameter's role (e.g., 'after_index: 0-based index to insert after'). However, it omits constraints like file_path validity and index bounds, so it's not perfect.

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 action ('insert') and the resource ('paragraph after the specified paragraph'). It effectively differentiates from sibling tools like 'add_formatted_paragraph' and 'replace_paragraph' by focusing on insertion at a specific index.

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 (e.g., 'add_formatted_paragraph' for different formatting needs). No prerequisites or context provided, such as the document needing to exist or the after_index must be within bounds.

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