Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Find item sites

find_item_sites
Read-onlyIdempotent

Builds a v2 item_sites.query 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_item_sites"
  }
}

Input Schema

NameRequiredDescriptionDefault
list_idNoQuickBooks' ID for the record. Used over `full_name` when both are sent. Choose at most one of: `list_id`, or the set (`item_site_filter`, `item_type_filter`). Members of a set combine with each other, not with the other choices.
iteratorNoPage through every match: QuBe Sync asks QuickBooks for each page in turn and sends each to your `webhook_url` as it arrives, all with the same `id`. On by default, with pages of 100 records; send `iterator=true` with `max_returned` for another size. Off when you send `iterator=false` (every match in one answer) or `max_returned` alone (at most that many, in one answer).
meta_dataNoUse the `meta_data` attribute to control whether query responses include counts. Options are NoMetaData (default), MetaDataOnly (count only), and MetaDataAndResponseData (count plus objects).
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`.
max_returnedNoLimits the number of objects that a query returns. (To get a count of how many objects could possibly be returned, use the `meta_data` query attribute.) The page size, with `iterator=true`. Sent without `iterator`, or with `iterator=false`, it's a cap instead: at most this many records come back, in one answer, and QuickBooks doesn't say whether more matched.
active_statusNoUsed in filters to select list objects based on whether or not they are currently enabled for use by QuickBooks. The default value is asActiveOnly, which selects only list objects that are active.
include_qbxmlNoAlso return the qbXML this compiles to, for debugging. Not part of the v2 request.
item_site_filterNoAllows you to report on Item Sites. Choose at most one of: `list_id`, or the set (`item_site_filter`, `item_type_filter`). Members of a set combine with each other, not with the other choices.
item_type_filterNoAllows you to report on a specific item type. Choose at most one of: `list_id`, or the set (`item_site_filter`, `item_type_filter`). Members of a set combine with each other, not with the other choices.
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

A3.5/5.0
Behavior4/5

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

Beyond the readOnly/idempotent/non-destructive annotations, the description discloses a genuinely important behavioral trait: the call does not return records directly but yields a v2 request to send, with QuickBooks' answer arriving as a webhook payload described by response_json. It also enumerates the error codes (1030, 3150, 3220, 3260, etc.) an agent must be prepared to handle, which annotations cannot convey. It stops short of describing timing or retry semantics for the webhook.

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

Conciseness4/5

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

The first sentence front-loads the core purpose and the second defines the output contract; the error catalog is itemized and scannable rather than prose. The error list is long, but each entry earns its place as an error code the caller may need to handle.

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?

With 10 parameters, nested objects, an output schema, and full annotations, the description covers the two things not encoded elsewhere: that the tool returns a request rather than data, and the error taxonomy. It is not fully complete because it never says what an Item Site is or how this query differs from the many sibling find_item_* queries.

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 90%, and the schema itself documents the iterator/max_returned interplay, active_status defaults, and the mutually exclusive filter sets in detail. The description adds little parameter meaning of its own beyond generally pointing at the request to build, so the baseline 3 for high-coverage schemas applies.

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 resource: 'Builds a v2 item_sites.query request.' It also clarifies the non-obvious output contract (a v2 request plus a webhook payload shape). It does not differentiate from close siblings such as find_inventory_sites or the other find_item_* tools, so an agent cannot tell from the description alone which item-type query to choose.

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?

There is no when-to-use or when-not-to-use guidance and no named alternative. The only selection rules present ('Choose at most one of: list_id, or the set (item_site_filter, item_type_filter)') live in the parameter schema, not in the description, so they do not count as tool-level usage guidance.

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