qbo_bill_payments_update

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

With no annotations provided, the description must fully disclose behavior. It introduces the critical sparse-update pattern and the mandatory SyncToken requirement, which is essential for QBO updates. However, it does not mention permissions, rate limits, or conflict handling, which would further enhance transparency.

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 a single, highly efficient sentence that conveys the core purpose and key constraints (sparse-update, required fields) without any superfluous words. It is front-loaded and perfectly concise.

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 (11 parameters, nested objects, no output schema), the description is too minimal. It does not mention the return value (expected updated BillPayment) nor the conditional structure of payment method objects. While the schema covers parameter details, the description should provide more operational context for a tool of this complexity.

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%, so the baseline is 3. The description reinforces that only provided fields are changed and highlights required parameters, but does not add new semantic meaning beyond the schema. The conditional nature of CheckPayment and CreditCardPayment is well-documented in 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 'Sparse-update an existing BillPayment record', combining a specific verb ('update') with a well-defined resource ('BillPayment'), and explicitly notes the sparse-update nature, which distinguishes it from the sibling 'create' and 'get/list' tools.

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 implies usage for updating existing records by stating 'Only provided fields are changed; Id and SyncToken are required.' It clearly identifies prerequisites (Id, SyncToken) but does not explicitly contrast with alternative tools or mention when not to use it. The sibling tools provide contextual contrast.

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