Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Update data ext def

update_data_ext_def
Read-onlyIdempotent

Modifies an existing data extension definition. Notice that this Mod doesn’t allow you to change the type originally assigned to the data extension def, but it allows you to change just about everything else, such as its name and the objects it is assigned to.

The data_ext_def_mod 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, 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": {
      "data_ext_name": "<data_ext_name>",
      "owner_id": "<owner_id>"
    },
    "name": "update_data_ext_def"
  }
}

Input Schema

NameRequiredDescriptionDefault
owner_idYes`owner_id` identifies who owns the data extension. Use 0 for QuickBooks custom fields that appear in the UI, or use a GUID for private extensions owned by an app.
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`.
data_ext_nameYesThe name of the data extension. If this is a custom field, `data_ext_name` will be visible as a label in the QuickBooks user interface.
include_qbxmlNoAlso return the qbXML this compiles to, for debugging. Not part of the v2 request.
assign_to_objectNo
data_ext_new_nameNoThe new name for this field.
remove_from_objectNo
include_ret_elementNo
data_ext_txn_requireNoIf `data_ext_txn_require` is true, this data extension field is required to be entered in transaction. The default value is false.
data_ext_list_requireNoIf `data_ext_list_require` is true, this data extension field is required to be entered in lists. The default value is false.
data_ext_format_stringNoThe string format required for the data extension.

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.2/5.0
Behavior2/5

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

The description opens with 'Modifies an existing data extension definition', which reads as a write operation while annotations declare readOnlyHint=true and destructiveHint=false; that framing conflicts with the structured safety profile. The second paragraph partly repairs this by explaining that the call returns the v2 request to send plus the webhook payload where QuickBooks' answer arrives, i.e. it compiles a request rather than mutating anything itself. That reconciliation is genuinely valuable but comes after a misleading lead, and nothing states permission or auth requirements beyond the error-code list.

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 well front-loaded and state the hard constraint early, and the return-shape sentence is informative. The bulk error enumeration of roughly twenty code/type pairs is long and largely redundant with the statement that 'the call result explains each', diluting the useful behavioral content. Structurally sound but padded.

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, the description does not need to explain return values, and it still usefully notes that the response is a v2 request plus a webhook payload. It also covers the main edge case (immutable type) and the accepted data_ext_def_mod qbXML wrapper. Gaps remain around permission/auth requirements and explicit routing against update_data_ext, but for an eleven-parameter update-definition tool this is close to complete.

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 73%, so the schema already documents most of the eleven parameters, including owner_id's 0-vs-GUID convention and the request_id echo behavior. The description adds only the field-level mapping that 'name' and 'the objects it is assigned to' are editable, which points loosely at data_ext_new_name, assign_to_object and remove_from_object without documenting the enum arrays or the include_ret_element/include_qbxml debugging flags. Marginal value over the schema, consistent with a 3 baseline.

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 opening sentence names a specific verb and resource ('Modifies an existing data extension definition') and immediately adds the key scope constraint that the type assigned at creation cannot be changed. That makes it distinguishable in principle from create_data_ext_def and delete_data_ext_def. It stops short of explicitly contrasting with the near-named sibling update_data_ext (a field rather than a definition), so an agent must infer the difference from the resource noun 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?

Usage is only implied: modify an existing definition, not create or delete one, and not change its type. There is no explicit statement of when to reach for this tool versus update_data_ext or find_data_ext_defs, and no prerequisite such as needing a known data_ext_name/owner_id pair first. Adequate for a routine update tool but leaves selection to inference.

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