Skip to main content
Glama

Caribooks (QuickBooks Online)

search budgets

search_budgets
Read-only

Search budget records in QuickBooks Online. A profit-and-loss budget with one amount per account per period. 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 budget comes back with every BudgetDetail line. Omit to return the first page of all budget 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=true and destructiveHint=false, so the safety profile is covered. The description adds genuinely useful behavior beyond that: results are full records including SyncToken, which tells the agent a write can follow without a re-read. It does not mention rate limits, truncation, or page size (those live in the schema criteria 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?

Three short sentences, each load-bearing: identity, record shape, and the practical consequence (no follow-up get; batch by Id IN). Nothing redundant and the key routing fact sits up front.

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 read tool with no output schema, the description covers what comes back (full records with SyncToken) and one efficient retrieval pattern. Filtering and pagination are fully handled by the schema, so the only remaining gap is error/empty-result behavior, which is minor.

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's schema text already documents operators, AND semantics, case sensitivity, the 1000-record page, and truncation. The description only adds the 'Id IN' pattern, which is marginal on top of an already thorough schema; baseline 3 is appropriate.

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 budget records in QuickBooks Online') and then characterizes what a budget record is ('a profit-and-loss budget with one amount per account per period'). The clause 'no get is needed after' implicitly distinguishes it from the sibling get_budget, so an agent can separate the two without opening either schema.

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 for batch lookup ('read several known Ids in one search with Id IN') and steers the agent away from a follow-up get_budget call. It never states when filtering/pagination is preferred over a plain search, but the routing context 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