insert_before_symbol

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

No annotations are provided, so the description must cover behavioral details. It mentions using the outline for insertion points and default preview, but lacks detail on error conditions, side effects, or confirmation mechanisms for writes. The behavior is only partially disclosed.

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 extremely concise, with two sentences covering the core functionality and default behavior. No extraneous information is present.

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 tool modifies files (write capability), has 8 parameters (3 undocumented), and lacks an output schema, the description is too minimal. It does not explain preview mechanics, error scenarios, or how the outline supplies insertion points. More detail is needed for safe and accurate 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?

Schema description coverage is 63%, with descriptions for symbol, text, path, line, and apply. The tool description does not add any additional meaning or constraints beyond what is in the schema, so it meets the baseline without compensating for the undocumented 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 text before a named declaration, with examples like imports or decorators. It distinguishes from the sibling 'insert_after_symbol' by specifying 'BEFORE' and providing typical use cases.

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 mentions default preview and apply=true for writes, implying when to use each mode. However, it does not explicitly contrast with alternatives like 'insert_after_symbol' or provide conditions for when not to use this tool.

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