create_shipping_option

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

No annotations are provided, so the description carries the full burden. It only states that the tool 'creates' a shipping option and requires an API key. It does not disclose behavioral traits such as whether duplicate names are allowed, whether the creation is idempotent, or any side effects (e.g., impact on existing shipping options).

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?

The description is two sentences: the first concisely states the purpose with examples, and the second specifies a critical prerequisite. No superfluous words. Front-loaded with action and resource.

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?

The tool has 5 parameters and no output schema. The description does not mention what the return value looks like (e.g., the created shipping option ID), error handling, or idempotency. Given the complexity (multiple parameters), more context would be helpful, such as linking to list_shipping_options to verify after creation or note that duplicate names might cause errors.

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 description coverage is 100%, and each parameter already has a clear description. The tool description adds minimal value: it gives examples for the name parameter and mentions '0 for free shipping' for price, but these are already implied or stated in the schema. The description does not explain relationships between parameters or default behaviors beyond what schema provides.

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 'Create a new shipping option' and provides examples like delivery, pickup, express. It distinguishes from sibling tools update_shipping_option and delete_shipping_option by focusing on creation. However, it doesn't differentiate from other create tools like create_product, but since the resource is clearly 'shipping option', it is sufficiently specific.

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 mentions the prerequisite 'Requires KARRITO_API_KEY environment variable' but does not provide guidance on when to use this tool vs alternatives (e.g., when to create vs update, or any preconditions like checking if shipping options already exist). No explicit 'when-not-to-use' information is given.

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