inline_variable

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

No annotations present, so description carries full burden. Discloses return of text edits (not direct application), zero-based coordinates, and safety refusal. Could mention additional side effects but major behaviors are covered.

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?

Concise and well-structured with labeled sections (USAGE, OUTPUT, IMPORTANT, SAFETY, requirement). 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 return type, prerequisite, coordinate system, and refusal condition. No output schema, so return value explanation is adequate. Minor gap: no discussion of undo or preview capabilities.

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 has 100% coverage with descriptions; description reinforces zero-based coordinates and cursor positioning context, adding value 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 expression. It is distinct from siblings like extract_variable and inline_method.

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 cursor positioning instruction, prerequisite (load_project), and a refusal condition for modified variables. Lacks explicit comparison with sibling tools but is otherwise strong.

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