describe_carrier

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

No annotations provided, so description carries full burden. It discloses what is returned (required config keys, supported services, label formats) and implies read-only behavior. Does not mention side effects, auth needs, or errors, but is sufficient for a describe tool.

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, no wasted words. Purpose and usage are front-loaded. Highly concise.

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?

Output schema exists, so description need not detail return format. It covers what info is returned and usage hint. Lacks mention of alternative sibling 'list_carriers', but overall complete for a simple describe 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 has 0% description coverage for parameter, but description explains that if 'carrier' is given, carrier-specific details are returned; otherwise, canonical request. Adds meaning beyond bare schema, though could clarify null behavior more explicitly.

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?

Description clearly states it describes the canonical shipment request and carrier-specific details if carrier is given. Verb 'describe' and resource 'shipment request and carrier config' are specific. Distinguishes from sibling 'create_label' by advising to call before it.

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?

Explicitly says 'Call this before `create_label` to learn exactly what to pass,' providing clear when to use. Does not mention when not to use or alternatives, but context with 'list_carriers' suggests this is for detailed info.

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