Rename Symbol

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

No annotations provided; description fails to disclose behavioral traits like mutation side effects, reversibility, or permissions needed. It says 'update all references' but does not elaborate on the nature of updates or if it's a workspace edit.

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?

Two concise sentences: first states purpose, second provides usage instruction. No redundant or wasted text.

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?

Lacks output schema; description does not explain what the tool returns (e.g., edit list, confirmation). For a refactoring tool with cross-project impact, more context on applying changes would be beneficial.

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 100%, so baseline is 3. Description adds minimal extra meaning beyond schema: restates that file/line/offset are needed but does not enrich understanding of newName or preview behavior.

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?

Description clearly states 'Rename a TypeScript/JavaScript symbol and update all references across the project.' It specifies the verb (rename), resource (symbol), and scope (update references), distinguishing it from sibling tools like moveSymbol or extractConstant.

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 basic usage instruction ('Provide the file path and the 1-based line/offset of any occurrence') but lacks explicit guidance on when to use this tool versus alternatives such as moveSymbol or inlineVariable, and no mention of prerequisites or when not to use.

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