PATCH /sale/:id (Sale)

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

Annotations indicate it is not read-only (readOnlyHint=false) and not destructive (destructiveHint=false). The description adds that it edits sale information and specifies that sellerId requires API Token authentication. No contradictory behavior is mentioned.

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 structured with a clear purpose line followed by a bullet list of parameters. It is somewhat verbose due to full parameter descriptions but remains easy to parse. Every part adds value.

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?

Input parameters are well-covered, but the absence of an output schema means the description should explain what the tool returns (e.g., the updated sale object). This gap reduces completeness for an agent expecting to use the response.

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?

The input schema only defines id and body as a generic object. The description fully compensates by listing each body field (requesterId, sellerId, quantity, etc.) with type and constraints (e.g., integer >0, decimal, W3C date format). This provides critical meaning beyond 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 it is for editing one or more fields of an individual sale in the Conexa system. The verb 'edição' and resource 'venda avulsa' are specific, and it is easily distinguishable from sibling tools like create_sale or delete_sale.

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_sale for new sales, delete_sale for removal). The only contextual note is about authentication for sellerId, but no broader usage context is provided.

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