clones_for_symbol

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

With no annotations, the description discloses return behavior (candidate class or null based on fingerprinting/clones) but lacks side effects, permissions, or mutation info. Adequate but not thorough.

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?

Single sentence, no wasted words. Slight awkwardness in phrasing ('The clone class containing a symbol') but overall efficient.

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 basic purpose and return conditions but lacks parameter details, examples, or output schema info. Adequate for a simple tool but gaps remain.

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?

0% schema coverage; description only hints at parameters ('by id / ref / path+line') without detailing each parameter's meaning, constraints, or mutual exclusivity. Insufficient for clarity.

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's purpose: finding the clone class for a symbol using id, ref, or path+line. It distinguishes from sibling 'find_clones' by focusing on the class rather than individual clones.

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?

The description implies when to use (for a symbol's clone class) but does not explicitly state when not to use or mention alternatives like 'find_clones' for listing all clones.

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