Insert Line Near Text

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

The description explains the basic insertion behavior and parameter roles, but lacks details on conflict resolution (e.g., if both target_text and target_paragraph_index are provided), error handling, or required permissions. Since annotations provide no safety hints, more transparency is needed.

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 with two sentences, the first functional and the second enumerating arguments. It could be improved by structuring the parameter list but remains acceptably brief.

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 complexity (6 parameters, 1 required, no output schema), the description lacks important context such as behavior when targets are ambiguous, expected outcome, and failure modes. It does not fully equip the agent for reliable invocation.

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 merely lists parameter names and types without explaining their meaning, defaults, or constraints. For example, line_text and line_style are not defined in context. This forces the agent to guess.

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 line or paragraph before or after a target paragraph, with options for text matching or index, making its purpose highly specific and distinguishable from sibling tools.

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 does not provide guidance on when to use this tool versus alternatives like add_paragraph or insert_header_near_text. There is no discussion of prerequisites or exclusion criteria.

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