Variants Batch Replace

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

Annotations already declare destructiveHint=true and idempotentHint=true, and the description goes beyond them by disclosing the weighted-token-bucket rate limit cost model (scaling with variants/languages/inventory_levels), the required write_products scope, the HTTP method and the API version. It stops short of saying what happens to existing variants omitted from the array, which is the key destructive-behavior detail.

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?

Front-loaded with the operation, then cost model, then endpoint/scope/version on separate lines. Four short lines with little waste, though the HTTP method line is largely redundant for an agent that cannot use raw endpoints.

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 destructive batch replace with no output schema, the description should clarify what happens to existing variants not included in the array, how variants carrying IDs are treated (updated vs recreated), and what failure modes exist. Rate-limit and scope details are covered; the destructive semantics are only implied.

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%, so the baseline is 3. The description adds the notion that the array is the complete replacement set and hints that cost scales with variant/language/inventory-level count, but the items schema is an empty additionalProperties object and the description supplies no field-level guidance for those variant objects.

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?

States a specific verb and resource with scope: 'Replace the full set of variants of a product in one call (array of variant objects).' The word 'full set' and 'replace' implicitly distinguish it from tiendanube_variants_batch_update and tiendanube_variants_update, though no sibling is named explicitly.

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 set-replacement framing hints at when to choose this over per-variant update, but it never states the alternative explicitly or the condition that selects it (e.g., 'use batch_update to patch only listed variants'). No prerequisites or exclusions beyond the required scope mention.

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