PATCH /product/:id (Product)

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

Annotations already indicate it's a read/write operation (readOnlyHint=false, destructiveHint=false). The description adds no additional behavioral context such as whether updates are partial or full replacements, idempotency, or validation.

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 clear list of fields, easy to scan. No redundant sentences, but could be more concise by omitting the translation header.

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?

While the description covers the input fields, it lacks information about the return value, error handling, or behavior after update. With no output schema, this gap is noticeable but not critical.

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% but the body parameter description points to the tool description. The description adds meaning by detailing all allowed fields (name, price, etc.) beyond the minimal 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 'Edição de campos de um Item/Serviço' (editing fields of a product) and lists the updatable fields. It distinguishes from siblings like create_product, delete_product, and list_products.

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?

No explicit guidance on when to use this tool versus alternatives (e.g., create_product or delete_product). No mention of prerequisites or constraints.

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