Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Update list display

update_list_display
Read-onlyIdempotent

A ListDisplayMod request opens a QuickBooks list element within the QuickBooks UI for modification.

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, 3120 object_not_found, 3150 missing_element, 3170 cannot_modify, 3175 in_use, 3176 locked, 3200 stale_edit_sequence, 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

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_mod_type": "<list_display_mod_type>",
      "list_id": "<list_id>"
    },
    "name": "update_list_display"
  }
}

Input Schema

NameRequiredDescriptionDefault
list_idYesQuickBooks' ID for the record. Used over `full_name` when both are sent.
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_mod_typeYesThe type of QuickBooks list element to open for modification in the QuickBooks UI. (`list_id` specifies the particular list element.)

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?

The annotations (readOnlyHint=true, idempotent, non-destructive, closed-world) would look contradictory for something called 'update', but the description resolves this by explaining the call only compiles a request and returns it, rather than mutating anything. It further discloses the return shape (v2 request + webhook payload, response_json data shape and status codes) and enumerates concrete error codes. It stops short of saying what the agent should do with the returned request or how long the webhook takes.

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 first two sentences are front-loaded and efficient, but the trailing block of roughly twenty error codes is a dense wall of identifiers that the description itself says 'the call result explains each', so much of it does not earn its space in a selection-oriented description.

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 need not be fully spelled out, and the description still sketches them. Parameters are fully covered by the schema. The only real gap for this complexity level is guidance on what to do with the emitted v2 request and the asynchronous webhook answer.

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 all four parameters, including the enum for list_display_mod_type and the list_id/full_name precedence note, are already documented in the schema. The description adds no parameter-level detail such as how list_id interacts with the chosen type. Baseline 3 applies when the schema carries the load.

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 names a specific operation and its effect: a ListDisplayMod opens a QuickBooks list element in the QuickBooks UI for modification, and the tool returns the v2 request plus the webhook payload shape. That is far more specific than the name alone. It does not, however, distinguish this from near siblings such as create_list_display or update_txn_display, leaving the agent to infer the difference from names.

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 rather than stated: the word 'display' and 'within the QuickBooks UI' suggest a human-in-the-loop flow, as opposed to programmatic mutation tools like update_account or update_customer. There is no explicit when-to-use/when-not sentence and no named alternative, so the agent must infer the routing.

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