Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Create ship method

create_ship_method
Read-onlyIdempotent

Adds a shipping method, for example, standard mail or overnight delivery. A ShipMethodRef aggregate refers to an item on the ShipMethod list. In a request, if a ShipMethodRef aggregate includes both FullName and list_id, FullName will be ignored.

The ship_method_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": {
      "name": "<name>"
    },
    "name": "create_ship_method"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameYesName is the case-insensitive short name of a list object (without ancestors). It must be unique within its hierarchy scope.
is_activeNoIf `is_active` is true, this object is currently enabled for use by QuickBooks. The default value is true.
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.
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

B3.4/5.0
Behavior4/5

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

Annotations already declare readOnly/idempotent/non-destructive, and the description adds the crucial context that resolves the apparent tension: this tool returns the v2 request to send plus the webhook payload shape and status codes rather than completing the write inline. It also enumerates the error codes (name_in_use, locked, insufficient_permission, etc.) an agent should expect to handle, which is genuine value beyond the annotations. Minor gap: it does not say whether the compiled request expires or how the webhook is correlated beyond 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.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Purpose is front-loaded in the first sentence, which is good, but the sixteen-item error-code dump occupies roughly half the text and is explicitly redundant ("the call result explains each"). The middle sentence about ShipMethodRef and the qbXML wrapper is dense and would read better as separated points.

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 request-compiling create tool with an output schema, the definition covers inputs, the deferred-execution model, the return channel, and the error surface. Since an output schema exists, the description need not explain response_json structure in detail. The only missing piece is any guidance on prerequisites or permissions for the eventual write, which the error codes hint at but do not state.

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 80%, so the schema already documents name uniqueness, is_active, request_id, include_qbxml, and include_ret_element; the description adds nothing to those. The ShipMethodRef FullName/list_id precedence rule is useful but refers to referenced aggregates rather than any of the five declared parameters. 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?

"Adds a shipping method, for example, standard mail or overnight delivery" gives a specific verb plus resource and even concrete examples of the entity. It does not distinguish itself from siblings such as create_payment_method or find_ship_methods, so the agent must rely on the name alone to disambiguate.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

There is no statement of when to use this tool versus find_ship_methods (for lookup) or create_payment_method. The only conditional guidance is an input-format rule (ShipMethodRef with both FullName and list_id, where FullName is ignored) and the note that the qbXML `ship_method_add` wrapper is accepted — both about how to call, not whether to call.

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