Update Stocks

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

No annotations provided, so description carries full burden. It states 'update stock quantities' but does not disclose behavioral traits like whether updates are absolute or incremental, idempotency, error handling, or required permissions. This is insufficient 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?

Three concise, front-loaded sentences with no waste. Every sentence adds necessary context without redundancy.

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?

Given lack of output schema and annotations, description omits return behavior (success/error handling), partial update support, and batch atomicity. Adequate for basic use but incomplete for a complex update 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%, so baseline is 3. Description adds value by summarizing required fields and referencing list_warehouses, but it largely restates schema descriptions. No extra syntax or constraints beyond 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 the tool updates stock quantities for FBS warehouses, specifying required identifiers (offer_id or product_id) and distinguishing FBS from FBO. This provides a specific verb+resource and differentiates from sibling tools like get_stocks.

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 explicitly guides users: use list_warehouses for warehouse IDs, provide per-item identifiers and stock, and notes FBS vs FBO distinction. However, it lacks an explicit alternative for FBO stock updates, which could be inferred but not directly stated.

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