Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Update preferences

update_preferences
Read-onlyIdempotent

Builds a v2 preferences.update request.

The preferences_mod wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).

Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3120 object_not_found, 3150 missing_element, 3170 cannot_modify, 3175 in_use, 3176 locked, 3200 stale_edit_sequence, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "accounting_preferences_mod": "<accounting_preferences_mod>"
    },
    "name": "update_preferences"
  }
}

Input Schema

NameRequiredDescriptionDefault
request_idNoYour own label for the request, sent to QuickBooks as its qbXML `requestID` and echoed in the raw answer (`response_xml`); optional, since the answer's webhook already carries the request's `id`.
include_qbxmlNoAlso return the qbXML this compiles to, for debugging. Not part of the v2 request.
include_ret_elementNo
accounting_preferences_modYes

Output Schema

NameRequiredDescriptionDefault
urlYesReplace {connection_id} with the customer's connection.
bodyYesThe JSON body: the arguments you passed.
qbxmlNoThe qbXML it compiles to. Only with include_qbxml.
methodYes
headersYesSend with the request. Resent unchanged when no 201 came back, it answers with the request already queued.
webhookYesJSON Schema of the payload POSTed to webhook_url once QuickBooks answers, with this operation's response_json (data shape and status codes).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.6/5.0
Behavior4/5

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

The annotations declare readOnlyHint=true despite an 'update' name, and the description resolves that apparent tension by explaining the tool only compiles a request rather than mutating anything. It also discloses the return channel (a webhook carrying response_json) and enumerates the error codes with names, which is genuine behavioral context beyond the annotations. It stops short of saying whether the built request is validated, has a TTL, or is single-use.

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

Conciseness3/5

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

The core purpose is front-loaded and easy to extract, but roughly half the text is a flat dump of twenty error codes that could live in the linked response documentation. The multi-clause webhook sentence is dense and would read better split into a clear input/output pair.

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?

Because an output schema exists, the description is not obligated to describe return values, yet it helpfully points at response_json and the status codes to handle. Error handling is thoroughly covered. The residual gap is parameter-level detail for include_ret_element and the nested preference fields.

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 coverage is 50%, so the description needs to carry weight: it clarifies that the qbXML `preferences_mod` wrapper is accepted for the required accounting_preferences_mod object, which is useful aliasing information. However, include_ret_element and the nested closing_date/closing_date_password fields receive no explanation, and the sensitivity of the closing-date password is unaddressed.

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?

The description states a specific verb and output: it 'builds a v2 preferences.update request' and returns that request plus the webhook payload the answer arrives in. That is far more precise than the tool name alone, which misleadingly suggests an executed update. It does not contrast itself with find_preferences, so sibling differentiation is left implicit.

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?

Usage is implied by the described flow: call this to construct a request, then send it and receive QuickBooks' answer via webhook. There is no explicit statement of when to prefer this over find_preferences, no prerequisites, and no note on what happens if the caller double-submits the returned request.

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