get_type_definition

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

Discloses return content includes 'attributes, super types, and constraints'. No annotations exist; description partially covers behaviors but lacks details on effects, auth requirements, or error states.

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?

Three front-loaded sentences plus an Args line. No redundancy, each sentence adds value: purpose, content, usefulness. Efficient and clear.

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 low complexity (1 param, output schema exists), the description sufficiently covers purpose, usage, and parameter detail. The output schema handles return structure, so no further explanation needed.

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?

Single parameter 'name' is clarified with examples and a description in the Args section, adding meaning beyond the schema. Schema has 0% description coverage, so the description compensates well.

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 'Get a specific type definition by name', with examples like 'hive_table'. Differentiates from sibling 'get_all_type_definitions' by specifying 'specific' and from 'get_entity_type_definition' by using 'type definition' instead of 'entity type definition'.

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 context 'Useful for understanding what attributes an entity type has', implying when to use. Does not explicitly state when not to use or mention alternatives like 'get_entity_type_definition'.

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