insert_paragraph

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

With no annotations, the description carries the full burden, and it does disclose the return value ("Returns the new paragraph count"). However, it omits the critical side effect for this tool: inserting at an index shifts the indices of subsequent paragraphs, which affects any index the caller holds. Permission requirements and whether the document is saved are also unstated.

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 short sentences, front-loaded with the core action, then placement, then the return value. No filler and nothing buried.

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?

A document mutation with five parameters and no annotations or output schema: the description supplies the return value, which is good. What it lacks is the index-shifting consequence of beforeIndex/afterIndex and any note on persistence or permissions, which matters for a tool where callers pass positional indices.

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 100%, so all five parameters — including the location enum and the documentId fallback — are already documented in the schema. The description restates the location options and style examples without adding format or constraint detail beyond what the schema supplies, so the baseline 3 applies.

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?

Specific verb plus resource ("Insert a new paragraph into the document") with the scope of operations spelled out — style, placement options, and return value. It is distinguishable from siblings like set_paragraph_text or insert_table, though it never names an alternative directly.

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?

"Insert at the start or end of the body, or before/after a given paragraph index" describes how placement works, which implicitly guides use of the location parameter. But there is no explicit when-to-use guidance versus set_paragraph_text, format_paragraph, or the other paragraph siblings, and no stated prerequisites.

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