Skip to main content
Glama
WYRE-AI

QuickBooks Online MCP Server

by WYRE-AI
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

qbo_customers_update

Sparse-update an existing Customer record. Only provided fields are changed; Id and SyncToken are required.

Instructions

Sparse-update an existing Customer record. Only provided fields are changed; Id and SyncToken are required.

Input Schema

NameRequiredDescriptionDefault
ActiveNoSet to false to deactivate the customer. QuickBooks Online has no void or delete operation for Customer.
BillAddrNoBilling address object with Line1, City, CountrySubDivisionCode, PostalCode
GivenNameNoFirst name of the customer
SyncTokenYesCurrent SyncToken of the record (required by QBO for sparse updates; fetch the record first to obtain it)
FamilyNameNoLast name of the customer
customerIdYesThe Customer ID to update
CompanyNameNoCompany name
DisplayNameNoDisplay name for the customer (required, must be unique)
PrimaryPhoneNoPrimary phone object, e.g. {"FreeFormNumber": "555-1234"}
PrimaryEmailAddrNoPrimary email address object, e.g. {"Address": "user@example.com"}

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv1.6.6

TDQS

A3.5/5.0
Behavior3/5

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

With no annotations, the description carries the full behavioral burden. It discloses mutation, sparse-update semantics, and required Id/SyncToken, but omits permissions, concurrency conflict behavior when SyncToken is stale, and broader error handling.

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, front-loaded with purpose and key constraints. Every clause adds useful information with no waste.

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

Completeness3/5

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

Adequate for a rich-schema update tool, but with no annotations or output schema the description leaves important behavioral context unstated, such as stale SyncToken handling and error outcomes. It covers the minimum needed to call correctly but has clear gaps.

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 10 parameters in detail. The description adds only the sparse-update behavior and restates required fields, without adding format or example detail beyond what the schema provides.

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

Purpose4/5

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

States a specific verb 'sparse-update' and resource 'existing Customer record'. The word 'existing' distinguishes it from qbo_customers_create, but no sibling alternative is named, so it falls short of full sibling differentiation.

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

Usage Guidelines3/5

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

Provides implied context: use when updating an existing customer, and only provided fields are changed. It does not say when to use this instead of qbo_customers_create or qbo_customers_get, nor does it state any exclusions, so guidance remains implicit.

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

Deploy Server

Other Tools