brc_update_prepayment

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

No annotations provided, so description carries full burden. Discloses that updates are not immediate without confirmWrite=true, acting as a safety guard. Mentions timestamp parameter implied for optimistic concurrency. Lacks explicit statements on authentication, error handling, or idempotency, but covers key behavioral constraints adequately.

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?

Three sentences: purpose, prerequisite, and critical warning. Every sentence adds unique value. No filler. Front-loaded with the core action, then supporting guidance.

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?

No output schema, so return value is unknown, but the update flow and safety mechanism are well described. Includes prerequisite call and user confirmation requirement. Lacks error scenarios or post-update behavior, but given the tool's complexity, the description covers essential operational context.

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 description coverage is 100%, baseline 3. Description adds meaning by connecting parameters to the update flow: timestamp from brc_get_prepayment is used for concurrency, and confirmWrite must be user-verified. Also clarifies that 'id' refers to parent prepayment. This enhances understanding beyond schema alone.

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 an existing parent Prepayment by id, distinguishing it from creating or deleting prepayments. It also specifies the scope (parent only) and prerequisite usage of brc_get_prepayment, which clarifies the resource and action.

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 retrieve the prepayment via brc_get_prepayment, implying a two-step process. Warns against calling with confirmWrite=true until user confirmation, providing clear usage boundaries. Also notes child prepayments are inaccessible through public API, preventing misuse.

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