brc_update_sales_rep

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

Discloses the non-destructive preview phase, requirement for explicit confirmation, and the meaning of confirmWrite. No annotations provided, so description carries full burden and meets it comprehensively.

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?

Every sentence adds value. Front-loaded purpose, follows with concise workflow. No redundancy.

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?

Workflow is thoroughly explained but no mention of return format after successful update. Lacks output schema details, though not strictly required. Adequate for an update tool with clear confirmation pattern.

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 60% (descriptions for id, companyName, confirmWrite). Description adds critical semantics for confirmWrite (preview vs. commit). However, parameters 'code' and 'name' lack additional context beyond schema.

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 it updates a BRC sales rep with a specific workflow. Distinguishes from sibling create/delete tools by detailing the two-phase confirmation process.

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 instructions: first call without confirmWrite, show preview, then retry with confirmWrite only after user confirmation. Also warns preflight does not constitute confirmation.

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