brc_generate_sales_invoice_from_quote

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

Given no annotations, description fully discloses the two-phase behavior: first call returns confirmation_required and payload preview, second call with confirmWrite: true performs the write. Also explains the confirmWrite parameter semantics and clarifies the confirmation process.

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 concise and well-structured: first sentence states purpose, following sentences detail the two-step process. No redundant information.

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?

Comprehensive for a two-phase tool, but lacks description of the final output after confirmWrite (e.g., returns the created invoice). Still, the description covers the essential preview and confirmation mechanics.

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 description adds significant value by explaining confirmWrite usage in detail (when to set true/false) and provides context for companyName with an example. This goes beyond the schema's basic descriptions.

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 'Generates a sales invoice from a BRC quote' with a specific verb and resource. It distinguishes the two-step process from other creation tools like brc_create_sales_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?

Explicitly provides step-by-step usage: first call without confirmWrite returns preview, then retry with confirmWrite only after user confirmation. Warns that preflight is not confirmation and that confirmWrite must not be true on first call.

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