Skip to main content
Glama

Caribooks (QuickBooks Online)

search recurring transactions

search_recurring_transactions
Read-only

Search recurring transaction records in QuickBooks Online. A template QuickBooks uses to create a transaction on a schedule, or on request. 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. Each result wraps the template's transaction under its type (Invoice, Bill, ...) with RecurringInfo. Omit to return the first page of all recurring_transaction records.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false, openWorldHint=false, so the safety profile is covered. The description adds value beyond that by disclosing the return shape (full records including SyncToken, meaning no follow-up get is required), which is genuine behavioral context for planning a workflow.

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?

Three tight sentences, front-loaded with the verb and resource, then the domain clarification, then the practical return/batching advice. No sentence is wasted and nothing is buried.

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 still communicates what comes back (full records with SyncToken) and how to batch reads, while the schema carries the complex filtering and pagination rules. It is complete enough to invoke correctly, with only minor room for stating pagination behavior in prose.

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 100% and the criteria parameter is exhaustively documented there (operators, ANDed filters, page limits, allowed fields). The description adds only the Id IN batching hint, which is already implied by the schema's IN operator, so the baseline 3 for high schema coverage applies.

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 recurring transaction records in QuickBooks Online") and explains the domain concept (a template QBO uses to create a transaction on a schedule). It implicitly distinguishes itself from get_recurring_transaction by noting that full records with SyncToken come back, so no get is needed, though it never names sibling tools 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?

Provides a clear usage pattern ("read several known Ids in one search with Id IN") and an exclusion ("no get is needed after"), effectively routing the agent away from per-record get calls. It stops short of a full when/when-not treatment against create/delete siblings, but the guidance is concrete rather than merely implied.

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