brc_update_sales_rep

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

With no annotations, the description discloses the two-step confirmation process and preview behavior. However, it does not detail other aspects like permissions, side effects, or return values.

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 front-loaded with purpose and provides necessary workflow details. It is slightly verbose but each sentence adds value.

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 the lack of output schema and annotations, the description covers the confirmation process well but omits return value, prerequisites, and error handling.

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 minimal value beyond the schema; it reiterates the confirmWrite workflow already in the schema description. Parameters code and name lack schema descriptions, and the tool description does not supplement them.

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 starts with 'Updates a BRC sales rep using structured MCP fields,' clearly stating the verb (updates) and the resource (sales rep). This distinguishes it from sibling tools like create and delete.

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?

The description provides explicit step-by-step guidance: first call without confirmWrite for preview, then retry with confirmWrite only after user confirmation. It clearly states when not to set confirmWrite.

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