brc_process_vat_category_rates

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

No annotations are provided, so the description carries full burden. It clearly discloses the behavioral trait: the first call without confirmWrite: true returns a confirmation_required response and a payload preview, and the agent must not treat a preflight as confirmation. This gives the agent complete understanding of the required 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?

The description is slightly long but each sentence serves a purpose. It is front-loaded with the primary action and endpoint. Some redundancy exists (e.g., mentioning the endpoint twice), but overall it remains efficient.

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 complexity (6 parameters, nested objects, no output schema), the description covers the essential behavioral and parameter aspects. It does not detail return values or error handling, but the focus on the two-step confirmation process is appropriate for the tool's primary use case.

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 schema covers 83% of parameters with descriptions. The description adds value by deprecating the 'payload' parameter in favor of 'vatCategoryRates', explaining the protocol for 'confirmWrite', and describing 'vatCategoryRates' as the full BRC payload array. This enhances understanding beyond the 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 what the tool does: 'Processes VAT rates for VAT categories via POST /v1/vatCategories/vatRates.' It specifies the HTTP endpoint, making the action unambiguous. However, it does not explicitly differentiate itself from sibling tools, though the context of VAT rates is distinct.

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 instructions on when and how to use the tool: requires a full vatCategoryRates array and confirmProcess=true, outlines a two-step process with a preflight call returning confirmation_required, and instructs the agent to show a plain-English draft and retry with confirmWrite: true only after user confirmation. It also warns against setting confirmWrite true on the first call or without explicit confirmation.

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