Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Create inventory site

create_inventory_site
Read-onlyIdempotent

Builds a v2 inventory_site.create request.

The inventory_site_add 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, 3100 name_in_use, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3175 in_use, 3176 locked, 3180 cannot_save, 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, 3270 missing_posting_account

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": {
      "name": "<name>"
    },
    "name": "create_inventory_site"
  }
}

Input Schema

NameRequiredDescriptionDefault
faxNoFax number.
nameYesName is the case-insensitive short name of a list object (without ancestors). It must be unique within its hierarchy scope.
emailNoE-mail address.
phoneNoThe telephone number.
contactNoThe name of a contact person for a customer or vendor.
is_activeNoIf `is_active` is true, this object is currently enabled for use by QuickBooks. The default value is true.
site_descNoDescription of the site.
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`.
site_addressNoThis aggregate supports at most five address lines. You can provide a structured address (Addr1-Addr3 plus City/State/`postal_code`/etc.) or use block mode (Addr1-Addr5 only).
include_qbxmlNoAlso return the qbXML this compiles to, for debugging. Not part of the v2 request.
parent_site_refNoA reference to the list object that is one level above this one.
include_ret_elementNo

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

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

Annotations already declare readOnlyHint=true and idempotentHint=true; the description is consistent with that by clarifying the tool compiles a request instead of performing the write, and that QuickBooks' actual answer arrives asynchronously via a webhook payload — a genuinely important behavioral fact not encoded in annotations. It also enumerates error codes and the condition each implies. It does not say how long the request stays valid or how to correlate the webhook to the request beyond the echoed request_id.

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 opening two sentences are front-loaded and efficient, but more than half the text is a flat run of ~30 error codes prefaced by 'the call result explains each', which makes the enumeration largely redundant at call time. That dump dilutes the operationally important request/webhook explanation an agent needs.

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?

For a 12-parameter, nested-object builder with an output schema and full annotation coverage, the description covers the essential mechanics: what is produced, that the response arrives via webhook, and the failure taxonomy. Return-value detail is correctly left to the output schema. Only minor gaps remain (request lifetime, retry semantics).

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 92%, so the schema already documents name uniqueness scope, parent_site_ref precedence rules, address block-vs-structured mode, and include_qbxml. The description adds no parameter-level meaning beyond that; its only schema-adjacent note is the qbXML wrapper alias, which is not an input field. Baseline 3 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?

States a specific verb and resource: 'Builds a v2 inventory_site.create request', plus the qbXML alias (`inventory_site_add`) and that it returns both the v2 request and the webhook payload shape. An agent knows exactly what this tool produces. It stops short of naming how it differs from close siblings such as update_inventory_site, so it is clear but not sibling-differentiating.

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 create semantics and by 'Returns the v2 request to send', which tells the agent this tool prepares rather than executes the call. There is no explicit when-to-use/when-not guidance, no mention of prerequisites, and no named alternative for modifying an existing site.

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