Skip to main content
Glama

Caribooks (QuickBooks Online)

search payments

search_payments
Read-only

Search payment records in QuickBooks Online. An accounting record of a customer payment already received. Payment processing is not supported; ProcessPayment must be omitted or false. 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. Omit to return the first page of all payment records.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.3/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 openWorldHint=false, so the safety profile is covered. The description adds value beyond that: results come back as full records including SyncToken (so no follow-up get is required), and the ProcessPayment flag must be omitted or false. It does not mention paging limits, though the schema does.

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?

Three compact sentences, front-loaded with the verb+resource and ending with the highest-value operational hints. The sentence "An accounting record of a customer payment already received" is a fragment, but it earns its place by defining the resource boundary.

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?

For a two-parameter, fully documented search tool with no output schema, the description covers what an agent needs: what is returned (full records with SyncToken), what is excluded, and how to fetch multiple known records at once. Paging/truncation behavior lives in the schema rather than the description, which is acceptable here.

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 a baseline of 3 would be defensible. The description still adds a concrete usage pattern not spelled out in the schema — resolving multiple known Ids with "Id IN" in a single search — and clarifies that the record type excludes payment processing, which shapes what criteria values are meaningful.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ("Search payment records in QuickBooks Online") and immediately narrows the resource to "an accounting record of a customer payment already received," which separates it from create_payment/send_payment/void_payment. The line "Payment processing is not supported" plus "no get is needed after" explicitly contrasts it with the processing and get_payment siblings.

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 real usage context: it tells the agent that a follow-up get is unnecessary and that several known Ids can be resolved in one call via "Id IN." It stops short of an explicit when-to-use-this-vs-search_invoices/search_bill_payments rule, but the search-vs-get distinction is clear enough to route correctly.

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