Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Find preferences

find_preferences
Read-onlyIdempotent

A PreferencesQueryRq request message returns information about many of the preferences that the QuickBooks user has set in the company file. Preferences can’t be modified through the SDK, only through the QuickBooks user interface. Note: If you include an explicit end tag in a PreferencesQueryRq request, you will receive an error if there is any space between the opening tag and the end tag. The following table shows valid and invalid ways of constructing this request:

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, 3150 missing_element, 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, 3264 merchant_services_subscription_required

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "find_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

Output Schema

NameRequiredDescriptionDefault
urlYesReplace {connection_id} with the customer's connection.
qbxmlNoThe qbXML it compiles to. Only with include_qbxml.
queryYesThe query parameters: the arguments you passed.
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

C2.8/5.0
Behavior4/5

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

Annotations already declare readOnlyHint/idempotent/non-destructive, but the description adds real value beyond them: the call compiles a v2 request rather than returning preferences directly, the answer arrives via webhook, and an enumerated set of error codes (1030, 3150, 3220, 3260, etc.) tells the agent what failures to handle. It stops short of 5 because the opening claim about returning preference information conflicts with that async behavior.

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

Conciseness2/5

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

The front half is pasted SDK documentation about qbXML end-tag spacing — including a reference to a 'following table' that does not exist — and is irrelevant to invoking this tool. The actually useful sentence about the v2 request and webhook payload is buried after the filler, so the definition is badly front-loaded.

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?

An output schema exists, so return shape and status codes needn't be spelled out, and the webhook delivery model is covered. However, for a tool whose only real control is include_ret_element, the description never says what is returned when it is omitted, leaving a meaningful gap for a zero-required-parameter tool.

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

Parameters2/5

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

With schema coverage at 67%, the description needs to compensate, and it adds nothing about the three parameters. It never explains request_id echoing, what include_qbxml debugging output contains, or that include_ret_element restricts which preference sections come back — the single most important behavioral parameter is undocumented in the narrative.

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

Purpose3/5

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

The verb+resource (find preferences) is identifiable, and the third sentence reveals the real contract: it returns a v2 request plus the webhook payload the answer arrives in. But the opening sentence says it 'returns information about many of the preferences,' which misdescribes what the tool actually does, and there is no differentiation from the update_preferences sibling beyond the confusing remark that preferences can't be modified through the SDK.

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

Usage Guidelines2/5

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

No explicit when-to-use or when-not-to-use guidance. The only contextual signal is the incidental note that preferences are read-only in the SDK, which is not framed as routing guidance and arguably conflicts with the existence of update_preferences. The agent is left to infer the use case.

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