Confirm Sale Invoice

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

Description adds 'Locks the invoice for editing' and 'Reversible via invalidate_sale_invoice', complementing annotations (destructiveHint=true). No contradictory info. Could mention state changes or requirements, but overall clear.

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?

Two concise sentences with front-loaded action. Every word adds value, no filler.

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?

Lacks output schema, so return value not described. No mention of required state or permissions. But given parameter simplicity and annotations, it is minimally adequate.

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?

Single parameter 'id' with schema description 'Object ID'. Description adds no extra meaning beyond schema, which already has 100% coverage. Baseline score of 3 applies.

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?

Clearly states verb 'Confirm' and resource 'sales invoice'. Additional detail 'Locks the invoice for editing' specifies effect. Distinguishes from sibling tools like 'invalidate_sale_invoice' and 'create_sale_invoice'.

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 when to use (confirm an invoice, lock editing) and explicit reference to reversal via 'invalidate_sale_invoice'. Lacks explicit prerequisites or when-not-to-use, but context is sufficient.

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