insert_paragraph

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

The description explicitly states that insertion uses revision mode, which is a key behavioral trait. With no annotations provided, this adds important context. It also explains the index counting method, but does not cover all behavioral aspects like whether styles must exist or what the output contains.

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 conveying all essential information without any redundant phrases. It is well-structured and front-loads the core action.

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 presence of an output schema and 5 parameters, the description provides sufficient context for the key parameters and insertion behavior. It references read_document for index counting, aiding understanding. However, missing explanation for path and author slightly reduces 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?

Schema description coverage is 0%, so the description must compensate. It adds meaning for after_index (counting from 0, see read_document) and style (optional, existing style names). However, it does not explain path, text, or author parameters, leaving gaps for 3 out of 5 parameters.

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 tool inserts a new paragraph after a specific index using revision mode. It distinguishes from siblings like delete_paragraph and replace_text by specifying the action and context.

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 implies usage by mentioning the after_index parameter and reference to read_document for index counting, and notes style is optional with existing names. However, it does not explicitly state when not to use this tool or provide alternatives like replace_text.

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