renamePreview

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

No annotations are present, and the description does not disclose behavioral traits beyond 'previews'. It fails to explain whether the tool is idempotent, read-only, or if it requires specific authorization. The return format or side effects are not mentioned.

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, which is concise. However, it is overly brief for a tool with complex nested parameters and no output schema, lacking necessary detail. Structure is adequate but benefits from front-loading the purpose.

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 has two parameters (one nested object), no output schema, and no annotations, the description is incomplete. It does not explain what the preview shows, how to use the result, or any behavioral context, leaving significant gaps for an agent.

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% with both parameters described. However, the description adds no additional meaning beyond the schema's descriptions. The terms 'transport' and 'rename refactoring proposal' are not elaborated, so the description provides no new semantic value.

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 states the verb 'previews' and the resource 'rename refactoring', clearly indicating a non-execution preview. However, it does not explicitly distinguish from sibling tools like 'renameExecute' or 'renameEvaluate', though the name and action imply a read-only preview.

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 like 'renameEvaluate' or 'renameExecute'. There is no mention of prerequisites, such as needing a renameRefactoring object from a prior evaluation, or that this should be used before executing a rename.

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