Skip to main content
Glama

Caribooks (QuickBooks Online)

search bill payments

search_bill_payments
Read-only

Search bill payment records in QuickBooks Online. An accounting record of a payment to a vendor. It does not initiate a bank or card payment.

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 bill_payment records.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.5/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. The description adds behavioral context: it clarifies no bank/card initiation, and the criteria description details limitations (no OR, no Line fields, pagination, truncation, case sensitivity, data unavailability). This goes beyond annotations, so a high score is warranted, though not perfect because it doesn't mention response format.

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?

The description is concise and front-loaded: it opens with the purpose and non-initiation caveat. The criteria parameter documentation is long but necessary given the tool's complexity. It does not waste words, though the length is justified by the utility. Slight deduction for not summarizing key limitations more tightly.

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 search tool with extensive schema coverage, the description is highly complete. It covers purpose, non-side-effects, filtering syntax, limitations, and pagination. Missing output schema is fine since it's a search tool. An agent has enough to call it correctly without external documentation.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The schema already provides very high coverage (100%) for the criteria parameter, but the description adds substantial value by explaining operators, AND semantics, field limitations, pagination, and case-sensitivity. The company parameter is simple and schema-covered. This exceeds schema-only meaning.

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?

The description clearly states it searches bill payment records in QuickBooks Online, specifying it is an accounting record of a payment to a vendor and explicitly notes it does not initiate a bank or card payment. This distinguishes it from payment initiation tools like 'send_payment' or 'create_bill_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?

The description implies usage for searching/filtering historical payment records, and the extensive criteria documentation covers how to construct filters. It does not explicitly mention when not to use it or alternative search tools (e.g., search_payments), but the criteria details provide strong usage guidance for filtering.

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