find_references

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

No annotations provided; description only states basic behavior (finds symbol usage). Does not disclose performance characteristics, dependencies, or whether it is read-only (implicit but not explicit).

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 sentences, efficient and front-loaded with purpose. No redundant information. Every word serves a 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?

Output schema exists, so return format is covered elsewhere. Description mentions list of files and lines, which is sufficient. Could optionally mention scope (entire codebase) or limitations, but overall adequate for a simple tool.

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 has one parameter 'name' with 0% description coverage. Description clarifies name is the symbol, but does not specify format (e.g., fully qualified, case-sensitive) or provide examples. Adds some meaning but could be more precise.

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 it finds where a symbol is used, returns files and lines. Distinguishes from siblings like find_definitions (which finds definitions) and search_code (text search).

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 on when to use this tool vs alternatives such as search_code or find_definitions. Does not explain conditions like requiring indexed codebase.

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