rulecart_add

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

No annotations are provided, so the description must disclose behavioral traits. It indicates this is a creation/mutation operation and lists parameters and an example. However, it does not mention idempotency, error handling, authentication needs, or side effects like overwriting existing rules. This is adequate but not comprehensive.

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 well-organized with a clear header, bulleted parameter list, and example. It is moderately concise; every sentence adds value. The example takes some space but is useful. Could be slightly tightened, but overall efficient.

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 tool creating a cart rule with many fields, the description thoroughly documents the data structure. The presence of an output schema (not shown but indicated) covers return values. Missing are error scenarios or post-creation behavior, but the description is sufficient for typical use.

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 input schema has only a single 'data' parameter of type string with 0% description coverage. The description fully compensates by detailing the expected JSON structure, including all key fields, their types, optionality, and an example. This adds critical meaning beyond the schema.

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 starts with 'Create a shopping cart rule (discount / promotion)', which clearly states the action (create) and the resource (shopping cart rule). It distinguishes itself from sibling creation tools like product_create or category_create by being specific to cart rules.

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 does not explicitly state when to use this tool or when to avoid it. It provides parameter details but lacks guidance on alternatives or exclusions. The usage is implied as 'when you need to create a discount rule', but no explicit context is given.

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