get_hover_info

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

Discloses important behaviors: zero-based coordinates and prerequisite. No annotations exist, so description carries full burden. It implies read-only operation but could explicitly state non-destructive nature.

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?

Extremely concise with key information front-loaded. Uses bullet points for readability. No superfluous sentences.

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, description adequately explains return values. Covers prerequisite, coordinate system, and typical usage. Fully sufficient for the tool's 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 100%, but description adds value by explaining output format (signature, Javadoc, quick info) and reinforcing zero-based coordinates. This goes beyond the schema's basic 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?

Clearly states it gets hover information (documentation) for a symbol at a position, and differentiates from sibling tools like get_javadoc or get_signature_help by specifying combined output (signature, Javadoc, quick info) similar to IDE hover.

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 guidance: position on any symbol, requires load_project first. Does not explicitly exclude alternatives, but the context and sibling list imply when this tool is appropriate.

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