insert_paragraphs

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

With no annotations provided, the description fully carries the burden of behavioral disclosure. It discloses index shifting via reverse order processing, single open/save optimization, and behavior of parameters like copy_format_from overriding style/num_id/num_level. It also explains the allow_untracked_edit safety guard against prompt injection. Minor omissions: no mention of error cases or performance implications.

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?

Three sentences with no fluff. First sentence states purpose, second details internal behavior, third lists supported features. Every sentence earns its place.

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?

No output schema exists, but the tool is an insert operation so return is likely success/failure. Description covers key aspects: insertion behavior, indexing, parameter interactions, and safety features. For a tool with 5 parameters, it addresses critical points. Could mention return value, but not essential.

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 coverage is 100%, and the description adds meaningful context beyond the schema: it explains that copy_format_from overrides style/num_id/num_level, and that allow_untracked_edit is a safety guard against prompt injection. It also clarifies internal index shifting. This adds value over the schema's field descriptions.

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 that the tool inserts multiple paragraphs in one operation, with specifics about index shifting, single open/save, and supported features like numbering and format copying. It distinguishes itself from sibling tools like delete_paragraphs or edit_paragraphs.

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 explains when to use it (insert multiple paragraphs) and internal handling (reverse order), but does not provide explicit when-not-to-use guidance or mention alternatives like edit_paragraphs for modifications. Sibling tools exist but no comparison is given.

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