Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Find hosts

find_hosts
Read-onlyIdempotent

A HostQueryRq request message returns information about the exact QuickBooks product and version with which you are communicating. Note: If you include an explicit end tag in a HostQueryRq 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_hosts"
  }
}

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
include_list_meta_dataNoUse this aggregate if you want the query to return list capacity metadata for each object type in QuickBooks.

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.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and openWorldHint=false, so the safety profile is covered. The description does add genuinely useful behavior beyond that: the call is asynchronous and returns a v2 request plus a webhook payload whose answer arrives via callback, and it enumerates the error codes and their meanings. That value is diluted by an irrelevant qbXML tag-spacing warning that describes raw request construction rather than this tool's 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 lead paragraph is copied product documentation about tag formatting, and it even promises 'The following table shows valid and invalid ways' while no table exists. The actual tool behavior and the error list appear only after this noise, so the definition is neither front-loaded nor free of dead weight.

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 need not be explained, and the description does cover the webhook delivery model and error codes. However, for an operation whose real difficulty is the two-step request/webhook workflow, it gives no guidance on how to consume the returned payload or which parameters matter for that flow.

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?

Schema coverage is 75% and all four parameters are optional, yet the description says nothing about request_id, include_qbxml, include_ret_element, or the nested include_list_meta_data. The only qbXML-adjacent remark concerns whitespace between tags, which does not clarify what any parameter does and could mislead an agent about include_qbxml.

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 definition eventually says it 'Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in', which implies a compiler/request-builder for a HostQuery, and the opening line does tie HostQueryRq to product and version info. But that intent is buried under lifted Intuit documentation prose, and it never distinguishes this from the many find_* siblings that list actual QuickBooks entities.

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 statement of when to call this versus alternatives, no prerequisite or sequencing guidance for the webhook round trip, and no indication of what to do with the returned v2 request. The only usage-adjacent content is a list of possible error codes, which tells the agent about failure modes but not about selection.

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