insert_paragraph

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

The description adds value beyond the destructiveHint annotation by disclosing that ODT paragraph IDs are positional and shift after insertion, requiring a re-read. This behavioral detail helps the agent anticipate side effects.

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 two sentences, front-loading the core purpose and supported formats, followed by a crucial warning. Every sentence contributes essential information without redundancy.

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 description covers the main behavior and a key caveat, but lacks details on the 'instruction' parameter, error handling, and return values. Given the tool's complexity and no output schema, more information would improve completeness.

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 only 43% schema description coverage, the description does not sufficiently compensate for the five undocumented parameters. It explains the anchor parameter and position implicitly, but leaves file_path, google_doc_id, new_string, instruction, and style_source_id largely unexplained.

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 a paragraph'), the resource ('paragraph'), and the method ('before/after an anchor paragraph by paragraph id'). It also lists supported formats (DOCX, ODT, Google Docs), which distinguishes it from other sibling tools like replace_text or add_comment.

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 specifies supported document formats and includes a critical warning about ODT paragraph IDs shifting, guiding the agent to re-read before further edits. It does not explicitly state when not to use this tool, but the context is clear.

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