Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Create item group

create_item_group
Read-onlyIdempotent

Adds an item group. ItemGroup objects represent items that are grouped together for fast entry, and an ItemGroupRef aggregate refers to one of these item groups. In a request, if an ItemGroupRef aggregate includes both full_name and list_id, full_name will be ignored. You can use an ItemGroupQuery request to get information about all the item groups that are set up in the QuickBooks file.

The item_group_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_item_group"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameYesName is the case-insensitive short name of a list object (without ancestors). It must be unique within its hierarchy scope.
bar_codeNoBarcode reference information.
is_activeNoIf `is_active` is true, this object is currently enabled for use by QuickBooks. The default value is true.
item_descNoThe description that will appear on a sales form when the item is used.
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.
item_group_lineNo
include_ret_elementNo
is_print_items_in_groupNoIf true, a list of this group’s individual items their amounts will appear on printed forms.
unit_of_measure_set_refNoThe unit of measure set consists of a base unit and 0-n related units.

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

B3/5.0
Behavior1/5

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

The description states the tool 'Adds an item group', a mutating create operation, while the annotations declare readOnlyHint=true and idempotentHint=true. Even though the text explains that the call returns a v2 request plus a webhook payload, the stated behavior of creating a QuickBooks record is inconsistent with a read-only, idempotent safety profile, so an agent cannot trust the annotation when deciding whether it is safe to call.

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 is front-loaded and the domain explanation is useful, but the paragraph drifts between object semantics, qbXML alias support, and query guidance, and the flat enumeration of 25 error codes is a large block whose value is mostly reference material. It is informative but not tightly structured.

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 an 11-parameter tool with nested objects and an output schema, the description covers the request/response model (v2 request plus webhook payload), the accepted qbXML alias, and the error surface, so an agent has what it needs to call it. The remaining gap is the missing explanation of why the safety annotations read as read-only for a create operation.

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 coverage is 82%, so the schema already documents nearly every parameter, including the full_name/list_id precedence rule and barcode sub-fields. The description's only genuine addition is that the qbXML `item_group_add` wrapper is accepted as an input form, which is not expressed in the schema, so the baseline of 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?

The first sentence gives a specific verb and resource ('Adds an item group'), and the following sentence defines what an ItemGroup is and how ItemGroupRef relates to it, so the domain object is unambiguous. It does not differentiate itself from near siblings such as create_item_sales_tax_group or create_special_item, leaving that distinction to the names alone.

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?

It mentions ItemGroupQuery for retrieving existing item groups and notes that the qbXML `item_group_add` wrapper is accepted, which gives some routing and input-alternative context. However, there is no explicit statement of when to use this versus update_item_group, nor any prerequisite or precondition for creating a group.

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