Skip to main content
Glama

Caribooks (QuickBooks Online)

update bill payment

update_bill_payment
Destructive

Update an existing bill payment in QuickBooks Online (requires Id and SyncToken).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
entityYesFields to update. Must include Id and the current SyncToken (fetch the BillPayment first). Do not send government identifiers (SSN or tax IDs), birth dates or card-processing details. Manage those fields directly in QuickBooks. Updates are sparse by default: only the fields sent change, and a Line array sent replaces all lines. Send sparse: false for a full update, which clears every writable field left out.
companyNoWhich connected QuickBooks company to use (name, realm id, or connection id). Optional when only one company is connected.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4/5.0
Behavior3/5

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

Annotations already mark destructiveHint=true and readOnlyHint=false, so the safety profile is known. The description adds that this is an 'update' of an 'existing' record, narrowing the destructive action to modification rather than deletion. However, it does not disclose the sparse vs. full update semantics or that a full update clears omitted fields; those critical behaviors are only in the schema, not the description.

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?

The description is a single, front-loaded sentence that states the verb, resource, and prerequisite without any fluff. It is appropriately sized for the tool's complexity and 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?

The overall definition is quite complete: annotations cover the destructive nature, the schema covers sparse/full update behavior, sensitive data restrictions, and company selection. The main description is lean but sufficient given the rich schema. The only notable gap is that no output/return behavior is mentioned, and there is no output schema, so the agent is left to infer what the tool returns.

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%, and both parameters have detailed descriptions in the schema. The main description only mentions 'requires Id and SyncToken', which is already stated in the entity parameter description. Thus the description adds no meaning beyond what the input schema already provides, keeping it at the baseline for high coverage.

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 clearly states the action ('update'), the resource ('bill payment'), and the context ('QuickBooks Online'), and the requirement of Id/SyncToken makes it unambiguous that this targets an existing record. It is easily distinguished from sibling tools like create_bill_payment, delete_bill_payment, and void_bill_payment.

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 and schema provide clear context: it updates an existing bill payment and requires Id and SyncToken, with the schema explicitly instructing to fetch the BillPayment first. However, it does not explicitly name alternatives or state when-not to use this tool (e.g., for new payments use create_bill_payment, for voiding use void_bill_payment), so it stops short of a 5.

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