Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Create list display

create_list_display
Read-onlyIdempotent

A ListDisplayAdd request opens a form within the QuickBooks UI for adding a list element.

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

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.
list_display_add_typeYesSpecifies the type of QuickBooks list for which to open an “add” form in the QuickBooks UI.

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?

Beyond the annotations (readOnlyHint=true, destructiveHint=false, idempotentHint=true, openWorldHint=false), the description discloses the actual mechanics: a v2 request is returned to send, and the answer arrives as a webhook payload with a defined response_json shape and status codes. The enumerated error codes add real behavioral surface (permission, read-only, locked, in-use cases) though the tool's auth prerequisites and what happens to the opened form are not stated.

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 in the first sentence, which is good. The remainder is dominated by a long inline enumeration of twenty-plus error codes and an awkward parenthetical about response_json, which reads as reference material rather than selection guidance and dilutes the signal.

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 an output schema present and full schema coverage, the description need not explain return values, yet it still conveys the request/webhook round-trip and the failure surface. For a three-parameter, single-enum tool the definition is nearly complete; only the post-call workflow (consuming the webhook answer) is left implicit.

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 100%, so the schema already documents request_id, include_qbxml, and the list_display_add_type enum. The description adds no parameter-level meaning beyond what the schema provides, 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 description states a specific action and resource: opening an add-form in the QuickBooks UI for a given list type (account, customer, vendor, etc.), which usefully corrects the misleading 'create' in the tool name by making clear no record is actually created. It does not name any sibling (e.g. update_list_display or create_customer) to say how this differs from actually persisting a record, so it stops short of full differentiation.

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 phrasing 'opens a form within the QuickBooks UI for adding a list element' and by mentioning the returned webhook payload, so an agent can infer this is a two-step UI-invocation flow. However, there is no explicit when-to-use/when-not guidance and no pointer telling the agent to use a different tool when it wants to actually create the entity.

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