find_references

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

Starts with 'Read-only. No side effects.' fully disclosing behavioral traits. No annotations provided, so description carries full burden; it meets this without contradiction.

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?

Extremely concise, front-loading key behavioral info, then stating purpose, prerequisite, and alternatives in a well-structured manner. No unnecessary words.

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 presence of an output schema (not shown) and full schema coverage for parameters, the description covers all essential aspects: purpose, usage, behavioral traits, and alternatives. No gaps.

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%, so baseline score 3. Description adds minor context (e.g., auto-detection of project_root) but does not significantly enhance understanding beyond the 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?

Clearly states verb ('returns'), resource ('references to a symbol'), and scope ('across the indexed codebase'). Distinguishes from siblings by naming alternative tools for different use cases.

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?

Explicitly states prerequisite ('Requires refs to be indexed') and provides clear guidance on when to use sibling tools instead ('For direct callers... use find_callers', etc.).

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