Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Create lead

create_lead
Read-onlyIdempotent

Builds a v2 lead.create request.

The lead_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, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3100 name_in_use, 3120 object_not_found, 3140 invalid_reference, 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": {
      "full_name": "<full_name>"
    },
    "name": "create_lead"
  }
}

Input Schema

NameRequiredDescriptionDefault
statusNoThe status of the lead.
full_nameYesThe record's name, parents first: `Jones:Kitchen:Cabinets`. Not case-sensitive.
locationsNo
main_phoneNoThe main phone number.
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`.
company_nameNoThe name of the QuickBooks user’s business, as specified in QuickBooks. `company_name` and Address are used on invoices, checks, and other forms.
include_qbxmlNoAlso return the qbXML this compiles to, for debugging. Not part of the v2 request.
lead_contactsNo
include_ret_elementNo
additional_contact_refNo

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?

The annotations declare readOnlyHint=true for a tool named create_lead, and the description resolves that apparent tension by stating the tool only compiles a request and returns it along with the webhook response shape — real value beyond the annotations. It also enumerates error codes and types, though it defers explanations to 'the call result' rather than saying what an agent should do with each.

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 dense with useful information, but roughly half the text is a 25-item error-code dump that the description itself says is explained elsewhere in the call result. That list is reference material rather than selection guidance and dilutes the actionable content.

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 still usefully explains what comes back (the v2 request and the webhook payload's data shape and status codes) and flags the error surface for a 10-parameter tool. The main gap is that the downstream 'send the request' step is referenced but never identified.

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 60%, and the description adds essentially no parameter-level meaning beyond noting that the qbXML `lead_add` wrapper is accepted as an alternate input shape. Notable parameters such as include_qbxml, include_ret_element, and request_id are left entirely to 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 opening sentence gives a specific verb and resource ('Builds a v2 lead.create request') and clarifies that the output is a request object plus a webhook payload, not a persisted record. It never distinguishes itself from update_lead or the many other create_* siblings, and the aside about the `lead_add` qbXML wrapper is ambiguous about whether it is an input form or an alternate tool.

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: an agent can infer this is the tool for originating a lead and that update_lead handles modification, but neither is stated. Critically, the description says it 'Returns the v2 request to send' without naming the step or tool that actually sends it, so the two-step workflow is left half-explained.

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