Skip to main content
Glama

Caribooks (QuickBooks Online)

void bill payment

void_bill_payment
Destructive

Void a bill payment in QuickBooks Online, keeping the record and its number but zeroing its amounts. Cannot be undone; requires explicit user confirmation.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesQuickBooks Id of the BillPayment to void.
companyNoWhich connected QuickBooks company to use (name, realm id, or connection id). Optional when only one company is connected.
confirmNoMust be true. Only set after the user has explicitly confirmed this void.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare destructiveHint=true and readOnlyHint=false, so the destructive nature is known. The description adds valuable context beyond the annotations: the record and its number are preserved, amounts are zeroed, the operation cannot be undone, and explicit user confirmation is required. This is meaningful behavioral disclosure for a destructive operation.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two sentences with zero waste. The core action and its key behavioral consequence are front-loaded, followed by the irreversibility warning and confirmation requirement. Every sentence earns its place.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a destructive single-resource operation with a fully documented schema and annotations covering the safety profile, the description is nearly complete. It covers what happens (void, zero amounts), what doesn't happen (record/number preserved), and the required precondition (explicit confirmation). It doesn't describe the return value, but there is no output schema and the operation's outcome is clear enough for an agent to call it correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the schema already documents all three parameters (id, company, confirm). The description adds the critical semantic that 'confirm' must be true and only set after explicit user confirmation, which reinforces the schema. However, it doesn't add much beyond that, so the baseline 3 is appropriate.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific verb ('Void'), a specific resource ('a bill payment in QuickBooks Online'), and the precise behavioral scope: it keeps the record and its number but zeroes its amounts. This clearly distinguishes it from delete_bill_payment and update_bill_payment, which are the closest siblings.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies when to use this tool: when the goal is to void rather than delete or update a bill payment. It does not explicitly name alternatives like delete_bill_payment or update_bill_payment, but the contrast is strongly implied by the phrase 'keeping the record and its number but zeroing its amounts.' The explicit confirmation requirement also gives clear usage guidance.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources