Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Find data ext defs

find_data_ext_defs
Read-onlyIdempotent

Finds the definitions of custom fields and private data extensions. Pass owner_id (0 for custom fields, your GUID for private extensions). Without it QuickBooks answers status 1 "did not find a matching object" even when definitions exist, so an empty answer there doesn't prove a field is missing (observed on QuickBooks Enterprise 24.0, 2026-10-03).

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, 3150 missing_element, 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, 3264 merchant_services_subscription_required

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "find_data_ext_defs"
  }
}

Input Schema

NameRequiredDescriptionDefault
owner_idNo`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. Choose at most one of: `owner_id`, or `assign_to_object`.
meta_dataNoUse the `meta_data` attribute to control whether query responses include counts. Options are NoMetaData (default), MetaDataOnly (count only), and MetaDataAndResponseData (count plus objects).
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.
assign_to_objectNoChoose at most one of: `owner_id`, or `assign_to_object`.
include_ret_elementNo

Output Schema

NameRequiredDescriptionDefault
urlYesReplace {connection_id} with the customer's connection.
qbxmlNoThe qbXML it compiles to. Only with include_qbxml.
queryYesThe query parameters: the arguments you passed.
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

A4/5.0
Behavior5/5

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

Annotations already declare the safe read-only/idempotent profile, yet the description adds substantial non-obvious behavior: the status-1 false-negative quirk (with version and date provenance), and the fact that the tool returns a v2 request plus a webhook response shape rather than direct data. The enumerated error codes further tell the agent what failure modes to expect and handle.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

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

Purpose, key parameter caveat, return shape, and errors are ordered sensibly and front-loaded. The ten-code error enumeration is somewhat heavy and partly redundant given the description itself says the call result explains each, which is the one place wording could be trimmed.

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 needn't document return fields, and it still usefully flags the unusual two-step request/webhook flow and the empty-result pitfall. The only residual gap is explaining what the caller should do with the returned request when the quirk is hit.

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

Parameters4/5

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

Schema coverage is 83%, so the baseline is 3, but the description adds genuinely new meaning by explaining the observed consequence of omitting `owner_id` (status 1 'did not find a matching object' even when definitions exist). It does not touch `meta_data`, `include_qbxml`, or `include_ret_element`, but those are well covered in the schema.

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 ('Finds the definitions of custom fields and private data extensions'), which cleanly separates it from update/delete/create siblings on the same resource. It does not explicitly name a sibling finder (e.g., find_data_ext for the data itself rather than its definitions), so the definitions-vs-data distinction is implied rather than stated.

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?

There is strong conditional guidance tied to `owner_id` (0 vs GUID) and a warning that an empty answer does not prove absence, which is effectively when-to-use guidance. However, the description never states when to prefer this over alternatives such as find_data_ext or the create/update definition tools, leaving that 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