Insert List Near Text

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

With no behavioral annotations (no readOnlyHint, destructiveHint, etc.), the description bears full burden. It only describes the operation and parameters, failing to disclose side effects, error conditions (e.g., missing target), permissions needed, or behavior when the target paragraph does not exist.

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 concise sentences. The first sentence states the core purpose and the second enumerates arguments. It is front-loaded with the essential information, and every sentence adds value 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?

Given no output schema and sparse annotations, the description covers the main action and parameters adequately. However, it omits error handling, return behavior, and interaction with document state (e.g., where the list index starts). It is minimally complete for a 6-parameter tool.

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 compensates by listing all 6 parameters with types, defaults, and brief semantic roles (e.g., 'position ("before" or "after")', 'bullet_type ("bullet" for bullets or "number" for numbered lists)'). It explains the targeting alternatives, though it could clarify the exact meaning of 'before' and 'after' relative to the target.

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 bulleted or numbered list before or after a target paragraph, using verb 'insert' and resource 'list'. It specifies the two targeting methods (by text or paragraph index), which distinguishes it from sibling tools like add_paragraph or insert_line_or_paragraph_near_text.

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 when to use each targeting method (by text or paragraph index) but does not explicitly state when not to use this tool or list alternatives among the many siblings. It lacks guidance on prerequisites or exclusions.

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