brc_update_sales_entry

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

Fully discloses the two-phase commit behavior: first call returns a payload preview, requires user confirmation before setting confirmWrite. Warns that preflight is not confirmation. No annotations, so description carries full burden and meets it.

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?

Description is concise with three key sentences plus parameter details. Front-loaded with main action and confirmWrite pattern. No wasted 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?

Covers usage and parameters well, but lacks description of successful response beyond confirmation_required mention. Given no output schema, a brief note on what a successful update returns would improve completeness.

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?

Adds significant meaning beyond schema: explains note default behavior (customer name, not product name), reference defaulting to 'Our Ref' and 'Your Ref', and precise confirmWrite usage rules. Schema coverage is 100% but description provides extra context.

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 tool updates a BRC sales entry with specific fields (note, reference). It distinguishes from siblings like brc_update_sales_invoice by specifying the resource and the safe text/reference fields.

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 instructs to first call without confirmWrite to get a confirmation required response, show a draft, then retry with confirmWrite only after explicit user confirmation. Also provides rules for when to set note and reference fields.

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