Skip to main content
Glama

Caribooks (QuickBooks Online)

update payment

update_payment
Destructive

Update an existing 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 Payment 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.3/5.0
Behavior4/5

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

The annotations already flag the operation as destructive and non-read-only, and the description adds the important precondition that a current SyncToken is required to update. The richer behavior—sparse updates, Line replacement, sensitive-field restrictions—lives in the schema rather than the description, but the description still surfaces the key versioning/precondition trait beyond the annotations.

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?

A single front-loaded sentence states the action, object, context, and the key precondition with no filler. Every word earns its place.

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

Completeness5/5

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

The schema fully documents sparse/full update semantics, line replacement, sensitive-field prohibitions, and company selection, while annotations cover the destructive nature. For this complexity level, an agent has everything needed to invoke the tool correctly, even without an output schema.

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 the entity schema already explains the required Id/SyncToken, sparse vs. full updates, Line-array replacement, restricted fields, and the optional company parameter. The tool description repeats only the Id/SyncToken requirement, adding no new parameter meaning beyond what the schema already provides, so it sits at the baseline.

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 action ('Update'), a specific resource ('an existing payment'), and the target system ('QuickBooks Online'). The words 'existing' and 'requires Id and SyncToken' clearly distinguish this from create_payment, get_payment, and lifecycle tools like void_payment or delete_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 conveys clear usage context: use it for modifying an already-created payment, not creating or reading one, and you must first have the Id and current SyncToken. It does not explicitly name alternatives or say 'use create_payment for new payments', so it stops short of a full when-not statement.

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