get_type_hierarchy

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

Describes behavior comprehensively: returns superclasses, interfaces, subtypes; notes zero-based coordinates; lacks annotations so description carries full burden. No contradictions.

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?

Well-structured with clear sections (USAGE, OUTPUT, IMPORTANT). Concise enough, though slightly verbose in explaining both modes; each 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?

Completely describes input modes, output content, and prerequisite. No output schema exists, but output is clearly explained. Sufficient for a hierarchy retrieval tool.

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%, baseline 3. Description adds meaning by explaining the two parameter groups (position vs. type name) and emphasizing zero-based coordinates, which improves usability.

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 the tool retrieves the type hierarchy (supertypes and subtypes) for a Java type. Distinguishes itself from sibling tools like analyze_type or get_type_at_position by focusing specifically on hierarchy traversal.

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 explicit usage modes (file position vs. type name) and output description. Mentions prerequisite 'Requires load_project to be called first.' Lacks explicit when-not-to-use vs. alternatives, but context is clear.

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