explain_symbol

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

No annotations provided; description carries full burden. It only says 'aggregate' and 'summary'—discloses no behavioral traits like read-only nature, data source details, error behavior, or output format. Minimal transparency for a tool combining multiple sources.

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?

Description is one sentence, concise and front-loaded. However, it may be too terse; adding context about output or usage would improve without losing conciseness.

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 aggregates multiple data sources but description lacks details on the summary format, structure, or behavior. No output schema, so description should fill gaps. Incomplete for a tool of this complexity.

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 0%; description adds no meaning to 'symbol_id'. Parameter name is self-explanatory but description should clarify its origin or format (e.g., from find_symbol). Does not compensate for lack of schema descriptions.

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 explicitly states it aggregates definition, references, endpoint, and git into one summary. This clearly distinguishes it from sibling tools that fetch individual pieces (find_symbol, find_references, get_endpoint, get_git_context). Verb 'aggregate' and specific sources make purpose unmistakable.

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 phrase 'Aggregate ... into one summary' implies use when a comprehensive overview is needed, but no explicit guidance on when to choose this over siblings, when not to use, or prerequisites. Usage context is implied rather than stated.

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