Skip to main content
Glama

Caribooks (QuickBooks Online)

search customers

search_customers
Read-only

Search customer records in QuickBooks Online. Results are full records with SyncToken, so no get is needed after; read several known Ids in one search with Id IN.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
companyNoWhich connected QuickBooks company to use (name, realm id, or connection id). Optional when only one company is connected.
criteriaNoCriteria accepts: an array of {field, value, operator} objects (operators: =, <, >, <=, >=, LIKE with % wildcards, IN), a simple {Field: value} object, or {criteria: [...], asc|desc: "Field", limit, offset, count}. Filters are ANDed; QuickBooks has no OR, cannot filter on Line fields, and only filters top-level fields (TxnDate, DocNumber, CustomerRef, VendorRef, Balance, TotalAmt, DueDate, MetaData.LastUpdatedTime, ...). Field names and values are case-sensitive as QuickBooks stores them. Government identifiers, birth dates and card-processing details are not available through these tools. One call returns one page of at most 1000 records, and a large page is truncated to fit the answer: narrow with filters or walk it with limit and offset rather than asking for everything. Inactive records are left out unless Active is filtered explicitly (Active: false, or Active IN (true, false) for both). Omit to return the first page of all customer records.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, destructiveHint=false, so the safety profile is covered; the description adds genuinely new behavior context, namely that returned records are complete (SyncToken present) and that multiple known Ids can be resolved in a single call. It does not itself mention that inactive customers are excluded or that a page is capped/truncated, though that detail does live in the criteria parameter text.

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

Conciseness5/5

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

Two sentences, front-loaded with the purpose, then the two operational facts an agent needs (complete records, batched Id lookup). No filler and nothing buried.

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

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a two-parameter read tool with a fully documented schema and no output schema, the description supplies what an agent needs to decide to use it: scope, completeness of results, and the bulk-Id pattern. Remaining details (filters, pagination, inactive handling) are thoroughly carried by the criteria schema text.

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 description coverage is 100%, so the baseline is 3; the description still adds value by surfacing the 'Id IN' operator for bulk lookups, which is a non-obvious usage pattern for the criteria parameter. It does not add meaning for the company parameter, but the schema already handles that.

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?

States a specific verb and resource ('Search customer records in QuickBooks Online') and adds the key scope fact that results are full records carrying SyncToken. It implicitly distinguishes itself from get_customer ('no get is needed after') but never names nearby siblings such as get_customer or search_customer_types explicitly.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives a concrete usage pattern: use this to read several known Ids in one call via 'Id IN', and skip a follow-up get because the records are complete. It stops short of stating when NOT to use it (e.g., single-record fetches, or how to pick between this and the dedicated customer reports).

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