Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Create special item

create_special_item
Read-onlyIdempotent

Adds special items to QuickBooks that can’t be added via the other Item*Add requests.

The special_item_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, 3040 invalid_amount, 3070 string_too_long, 3100 name_in_use, 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": {
      "special_item_type": "<special_item_type>"
    },
    "name": "create_special_item"
  }
}

Input Schema

NameRequiredDescriptionDefault
bar_codeNoBarcode reference information.
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`.
external_guidNoAllows for the attachment of a user defined GUID value.
include_qbxmlNoAlso return the qbXML this compiles to, for debugging. Not part of the v2 request.
special_item_typeYesIdentifies the type of special item. See type for possible enum values.
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.6/5.0
Behavior4/5

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

Annotations already declare readOnlyHint/idempotentHint/openWorldHint, so the safety profile is covered. The description adds real value beyond that: the accepted qbXML alias `special_item_add`, and the fact that the call yields a v2 request plus the webhook payload that the real answer arrives in. The only weakness is the opening "Adds special items to QuickBooks", which reads as an immediate write and is only reconciled with readOnlyHint by the following sentence about returning a request to send.

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 purpose and return-shape information is front-loaded and well structured, but roughly half the text is a 20-entry error code dump that duplicates what the call result reportedly explains. That block inflates length without much decision value.

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?

An output schema exists, so return values needn't be described, and the error taxonomy plus the qbXML alias note cover the main operational surprises for a QuickBooks item create. What's missing is any guidance on the three special_item_type enum meanings and on permissions, which matters for a tool whose annotations suggest no write occurs.

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 83%, so the schema already documents nearly every parameter (bar_code, request_id, include_qbxml, include_ret_element, special_item_type). The description adds nothing parameter-specific, which is acceptable at this coverage level but leaves no extra semantic value.

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 first sentence states a specific verb and resource ("Adds special items to QuickBooks") and distinguishes it from the sibling Item*Add tools by scope ("can't be added via the other Item*Add requests"). It does not name the specific sibling it supersedes, but the boundary is clear enough for selection.

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 exclusion clause: use this when an item type is not supported by the other Item*Add endpoints. There is no explicit when-not guidance, no prerequisites (e.g., required permissions for special items), and no named alternatives, so an agent must infer the routing decision.

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