find_symbol

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

The description explains the search behavior (partial match, kind filter) and the return structure (file, line, signature). However, it does not address performance, scope limitations, or side effects. Since no annotations are provided, the description carries the full burden but could be more 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?

The description is concise and front-loaded with the purpose. The Args/Returns section is efficiently structured, adding necessary detail without superfluous text. Every sentence adds value.

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's three parameters and required inputs, the description covers the essential behavior and return format. It is complete for a basic search tool, though it could hint at usage with sibling tools for advanced cases.

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?

The description adds meaning to all three parameters (path, name, kind) beyond the input schema, which lacks descriptions. It clarifies that name supports partial matching and kind offers specific filters, compensating for the 0% schema coverage.

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 that the tool searches for functions, classes, or variables in a project, specifying the action and resource. It also mentions partial matching and kind filtering, which distinguishes it from sibling tools like get_symbol_detail or search_code.

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 provides no guidance on when to use this tool versus alternatives such as search_code or get_symbol_detail. There is no mention of preferred use cases or when to avoid using it.

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