Invalidate Sale Invoice

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

Annotations indicate non-destructive, idempotent. Description adds context about returning to draft status and traceability requirements, which goes beyond annotations. However, does not explain full behavioral impact (e.g., effect on related records).

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 front-loading the main purpose and prerequisite. Every sentence adds value. No unnecessary words.

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 one parameter and no output schema, the description covers purpose, prerequisite, and compliance note. Complete for a simple mutation tool in context of siblings.

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'. Schema coverage 100%, so baseline 3. Description does not add extra parameter context beyond what schema provides. No additional semantics needed given tool simplicity.

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 the action: 'Return a confirmed sale invoice to draft status for editing.' Distinguishes from sibling tool 'delete_sale_invoice' by noting it is a prerequisite. Specific verb and resource.

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?

Explicitly states when to use: 'Required before delete_sale_invoice against a CONFIRMED invoice.' Provides context about traceability and compliance (RPS § 10), helping agent decide when to invoke.

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