get_symbol_info

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

No annotations provided, so description carries the burden. Discloses zero-based coordinates and output contents (kind, modifiers, signature, location). Implies a read operation with no side effects, but does not explicitly state read-only or mention error cases.

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 relatively concise with three short sections (purpose, usage, output, important note). Each sentence adds value; no fluff. Could be slightly more streamlined but overall efficient.

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 no output schema, the description adequately outlines output fields (kind, modifiers, signature, location). Prerequisites and coordinate system are covered. For a tool of moderate complexity, this provides sufficient context for an AI agent to use it correctly.

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?

Input schema has 100% coverage with descriptions already specifying zero-based coordinates. The description reinforces this, but adds no new meaning beyond what the schema provides. Baseline of 3 is appropriate.

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 it gets detailed info about any symbol at a position, with specific verb 'get' and resource 'symbol info'. It covers types, methods, fields, and variables, but does not explicitly distinguish from siblings like get_method_at_position or get_type_at_position, which are more specific.

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?

Provides clear usage instructions: position on any symbol and prerequisite to call load_project first. Emphasizes zero-based coordinates. However, no guidance on when to use this tool versus alternatives (e.g., get_method_at_position for method details).

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