explain_symbol

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

Without annotations, description should disclose behavioral traits. It states it gets data but does not mention side effects, permissions, or rate limits. It implies a read operation but lacks explicit safety guarantees.

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 efficiently conveys purpose and efficiency advantage. No wasted 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?

Tool has 5 parameters and returns multiple pieces of info. Description explains what it returns but lacks details on return format. For a combined operation, more context on output structure would be helpful.

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 descriptions for all 5 parameters. The description adds a useful default value for rootDir (defaults to projectRoot), which is not in the schema. Mostly redundant but one extra detail.

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?

Description clearly states it gets signature, location, and callers of a symbol in one call. It distinguishes from sibling tools like read_file_surgical and analyze_impact by highlighting efficiency.

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?

Description mentions it's more efficient than combining read_file_surgical and analyze_impact, implying use when all three pieces of info are needed. However, it does not explicitly state when not to use it.

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