Upsert product

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

No annotations are provided, so the description must carry the burden. It only says 'Create or update,' but does not disclose whether the operation is idempotent, what happens to existing fields on update, whether specific permissions are needed, or any side effects. This is inadequate for a mutation 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?

The description is a single sentence that front-loads the operation ('Create or update') and identifies the resource ('product'). It is concise, clear, and every word earns its place.

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 an 8-parameter mutation tool with no annotations and no output schema, the description is too sparse. It does not explain upsert behavior, distinguishing between create and update paths, or the significance of required vs optional parameters. The schema covers parameter details but not the behavioral semantics needed for correct 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?

Schema description coverage is 100%, so parameters are fully documented in the schema. The description adds the key fact that productNumber is the lookup key, which is helpful but not substantial. It does not clarify upsert-specific requirements like productGroupNumber being required only on create, which is left to 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 clearly states 'Create or update a product by productNumber.' This is a specific verb+resource+key, distinguishing it from sibling tools like list_products or update_customer. It precisely communicates the upsert operation and the unique identifier.

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 implies usage: use this when you need to create or update a product. However, it does not explicitly mention when not to use it or contrast with alternatives. Since there is no other product-write tool among siblings, the context is clear but not fully explicit.

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