inline_variable

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

Discloses zero-based coordinates, refusal if variable modified after initialization, prerequisite, and output format. No annotations exist, so description carries full burden; no contradictions.

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?

Well-structured, front-loaded with purpose, clearly separate sections for usage, output, and safety. No redundant sentences.

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?

Covers key aspects: action, usage, coordinate system, safety, prerequisite, output. No output schema but return value explained. Sibling inline_method exists but context adequate.

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 coverage is 100%. Description adds context about zero-based coordinates and cursor positioning, but does not add significant meaning beyond schema.

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 inlines a local variable by replacing usages with its initializer, distinguishing it from siblings like inline_method and extract_variable.

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?

Provides explicit usage instruction (position cursor on declaration or usage) and prerequisite (load_project). Lacks contrast with sibling inline_method but includes safety condition that implies when-not.

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