Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Delete data ext def

delete_data_ext_def
Read-onlyIdempotent

Deletes the private data extension definition specified by owner_id and data_ext_name. This delete will be successful only for private data extensions.

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, 3160 cannot_delete, 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": "delete_data_ext_def"
  }
}

Input Schema

NameRequiredDescriptionDefault
owner_idYes`owner_id` identifies the extension owner. `owner_id` 0 means a public custom field visible in the QuickBooks UI. A GUID means a private app extension that is not shown in the UI.
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.

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?

Annotations already declare readOnlyHint=true, destructiveHint=false and idempotentHint=true, but the description adds substantive context beyond them: private-only eligibility, the request-compilation model ('Returns the v2 request to send, and the webhook payload'), the response_json shape, and a catalog of status codes with types. The only blemish is that the opening verb 'Deletes' (and 'this delete will be successful') describes the effect of the emitted request rather than the MCP call, which reads slightly at odds with the read-only hint until the next paragraph clarifies it.

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. The remainder is dominated by a 20-entry inline error-code dump (1030 through 3264) that is mostly reference material and not scannable; trimming to the deletion-relevant codes (3160 cannot_delete, 3175 in_use, 3176 locked, 3220 not_authorized) would keep the signal without the wall of text.

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 spelled out, yet the description still tells the agent what comes back (v2 request plus webhook payload/response_json) and which status codes to handle. Combined with the private-only restriction and full schema coverage, an agent has enough to call this correctly; only the read-only vs 'delete' framing would benefit from an explicit sentence.

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 owner_id (0 = public field, GUID = private extension) and data_ext_name are already fully documented in the schema. The description restates the two required keys without adding format, validation, or interaction detail (e.g. what happens when owner_id is 0), 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 first sentence gives a specific verb and resource ('Deletes the private data extension definition') and scopes it by the two identifying keys, owner_id and data_ext_name. It also narrows scope to private extensions, which distinguishes it from the public/custom-field world. It does not name a sibling (e.g. update_data_ext_def or delete_data_ext), so differentiation still rests on the tool name.

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?

'This delete will be successful only for private data extensions' is a real precondition and effectively a when-not rule for public extensions (owner_id 0). However, there is no explicit when-to-use guidance relative to update_data_ext_def, find_data_ext_defs, or the sibling delete_data_ext, so the agent must infer 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