update_product

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

Describes side effects: changes immediate, irreversible, no version history. Specifies API endpoint (PUT /v1/products/{product_id}) and return structure. Despite no annotations, description fully discloses behavioral traits.

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?

Well-organized with sections: purpose, usage, API info, return structure, side effects. No redundant sentences. Front-loaded key information.

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?

Despite no output schema, description includes return structure (dict with success, resource_id, message). Covers side effects and irreversibility. Complete for a mutation 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 coverage is 100% with descriptions for both parameters. Description adds value by explaining that product_data requires only fields to update, and explicitly lists return structure fields not in 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?

Description clearly states it updates basic product info (name, description, category, status) using [WRITE] prefix. Distinguishes from siblings like update_product_price and update_product_quantity by specifying scope of update.

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?

Provides clear use case: modify existing product fields. Includes partial update hint ('only pass fields to modify, others unchanged'). However, does not explicitly exclude alternative tools like update_product_price.

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