get_metadata

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

No annotations are provided, so the description carries the burden. It implies a safe read-only operation via 'Get' and indicates the type of data returned. However, it does not disclose return format, pagination, or other behavioral details. For a simple metadata lookup, this is adequate but not rich.

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?

Two sentences, front-loaded with the verb and resource, and zero wasted words. The first sentence states the purpose; the second provides a practical example.

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?

For a low-complexity tool with one parameter and no output schema, the description gives the essential purpose, the types of metadata, and a usage scenario. It lacks explicit return structure, but the provided details are sufficient for basic selection and invocation.

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?

The schema provides 100% parameter coverage with an explanatory description for entity_type. The tool description adds a concrete use case (order state hrefs) that helps an agent decide which entity_type to pass, going beyond the schema's generic examples.

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 the tool retrieves metadata for entity types, naming the kinds (states, attributes, price types) and a concrete use case (finding order state hrefs for update_customer_order_status). This is a specific verb+resource that distinguishes it from sibling tools.

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 description explicitly says 'Use to find order state hrefs for update_customer_order_status,' providing a clear context for when to invoke it. It does not explicitly list alternatives or when-not-to-use, but the scenario is well-defined.

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