Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Create alert

create_alert
Read-onlyIdempotent

Builds a v2 alert.create request.

The alert_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, 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": {
      "alert_tag": "<alert_tag>",
      "desc": "<desc>",
      "help_text": "<help_text>",
      "message_text": "<message_text>",
      "owner_id": "<owner_id>"
    },
    "name": "create_alert"
  }
}

Input Schema

NameRequiredDescriptionDefault
descYes
owner_idYes
alert_tagYes
help_textYes
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`.
ui_contextNo
message_textYes
include_qbxmlNoAlso return the qbXML this compiles to, for debugging. Not part of the v2 request.
activation_dateNo
expiration_dateNo
alert_permissionNo
com_callback_infoNoChoose exactly one of: `com_callback_info`, or `http_callback_info`.
http_callback_infoNoChoose exactly one of: `com_callback_info`, or `http_callback_info`.

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.3/5.0
Behavior4/5

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

Annotations already declare readOnlyHint/idempotentHint/destructiveHint=false, and the description is consistent with them by framing the tool as a non-mutating request builder. Beyond the annotations it adds genuinely useful behavior: the call returns both the outbound v2 request and a webhook payload with a described data shape and status codes, plus an enumerated error taxonomy to handle. The exhaustive error-code dump is somewhat raw but is real behavioral disclosure.

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 statements are front-loaded and efficient, but the trailing block of fourteen error.code/error.type pairs is bulky and diluted by the caveat 'the call result explains each', which undercuts the need to list them at all here.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/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 re-explained, and the description still usefully characterizes the webhook payload. However, for a 13-parameter tool with nested objects and low schema description coverage, the omission of any parameter or required-field guidance leaves the agent with real gaps before it can invoke this correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is only 31% across 13 parameters with nested objects (alert_permission, com_callback_info, http_callback_info), so the description bears responsibility to compensate — and it says nothing about any parameter. The one meaningful detail (choosing exactly one of com_callback_info or http_callback_info, and prog_id vs. clsid) lives only in the schema, not the description.

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 gives a specific verb and resource ('Builds a v2 alert.create request') and crucially clarifies that this is a request builder, not an executing create — an important distinction given the name create_alert and the readOnly annotation. It also notes the qbXML alert_add wrapper is accepted. It stops short of naming a sibling (e.g. delete_alert) as the contrasting operation.

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 only implied: 'Returns the v2 request to send' tells the agent it must dispatch the result itself, and the webhook sentence hints at the follow-up step. There is no explicit when-to-use vs. when-not guidance and no named alternative for actually sending the alert.

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