renamePreview

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

There are no annotations, and the description 'Previews a rename refactoring' gives no detail about side effects, what the preview returns, or whether it is safe. The term 'preview' implies a read-only operation, but that is not explicitly stated.

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 a single sentence with no wasted words, but it is under-specified. It is not a tautology and is appropriately brief, but it lacks enough substance to be considered genuinely helpful on this dimension.

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?

With 2 parameters, no output schema, and no annotations, the description does not provide sufficient context. It fails to explain what a 'preview' entails, how the transport parameter factors in, or how this relates to the renameExecure/renameEvaluate steps.

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% for both parameters, so the baseline is 3. The description adds no additional meaning about the renameRefactoring object or the transport parameter beyond what the schema already provides.

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 action ('Previews') and the resource ('a rename refactoring'). It is specific enough to understand the tool's function, though it does not explicitly distinguish itself from sibling tools like renameEvaluate or renameExecute.

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?

No guidance is provided on when to use this tool versus alternatives. It does not mention that this should be used before executing a rename or how it differs from the evaluate or execute variants.

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