brc_delete_sales_invoice

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

Describes the two-step confirmation process and the need for explicit user confirmation. However, it does not mention the return format or potential error outcomes, though this is acceptable for a delete tool with clear workflow.

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 sentences, no wasted words. Front-loaded with action and immediately follows with essential steps.

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?

Completely covers the tool's behavior given its complexity. No output schema is needed as the description explains the return value pattern ('confirmation_required and a payload preview').

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 description adds significant meaning to the confirmWrite parameter by explaining its role in the two-step confirmation process. It also warns against setting it true incorrectly. The confirmDelete parameter is not explained, but has a default value and is less critical.

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 action ('Deletes'), the resource ('BRC sales invoice'), and the method ('by id using timestamp confirmation'). It distinguishes this tool from siblings like brc_delete_sales_credit_note.

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 explicit step-by-step guidance on how to use the tool: first call without confirmWrite, then retry with confirmWrite after user confirmation. Also warns that 'Passing preflight is not confirmation' and specifies when confirmWrite must be set to true.

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