Skip to main content
Glama

Caribooks (QuickBooks Online)

search tax payments

search_tax_payments
Read-only

Search tax payment records in QuickBooks Online. Sales tax (GST/HST, QST, VAT) payments and refunds recorded against filed returns; AU, CA and UK companies only. 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 tax_payment records.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.4/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 still adds value beyond them: that returns are full records including SyncToken (eliminating follow-up reads) and that the tool is region-restricted to AU/CA/UK entities.

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 dense sentences with no filler, and the most decision-relevant information (what it searches, region restriction) is front-loaded. Every clause carries information an agent needs.

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 no output schema, the description compensates by describing the shape of results (full records with SyncToken) and the region constraint, while pagination and criteria mechanics live in the schema. Adequate for a two-parameter read tool, though the returned record structure itself is only loosely characterized.

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 100% and the criteria parameter is exhaustively documented in the schema, so the baseline is 3. The description adds a genuinely useful usage idiom for that parameter (querying several known Ids in a single call with Id IN) that the schema only implies via the operator list.

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+resource (search tax payment records), defines scope precisely (sales tax payments/refunds recorded against filed returns), and adds a hard constraint (AU, CA and UK companies only). This clearly separates it from siblings like search_tax_agencies, search_tax_codes, search_tax_rates and get_tax_payment.

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 concrete routing guidance: results are full records with SyncToken so a follow-up get is unnecessary, and multiple known Ids can be read in one call via Id IN. It also states an eligibility condition (AU/CA/UK only). It stops short of explicitly naming get_tax_payment as the alternative for single-record retrieval, but the implication is clear.

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