Skip to main content
Glama

Caribooks (QuickBooks Online)

search vendor credits

search_vendor_credits
Read-only

Search vendor credit records in QuickBooks Online.

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

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.8/5.0
Behavior3/5

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

Annotations already establish this as read-only and non-destructive, and the top-level description adds no behavioral trait beyond 'search'. It is consistent with the annotations, but pagination, truncation, filtering limits, and unavailable fields live in the schema rather than the description, so the description itself is adequate but not rich.

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?

The tool description is a single, front-loaded sentence with no wasted words. The long criteria explanation is correctly placed in the schema instead of cluttering the description.

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?

Taken as a full definition, the clear one-liner plus the detailed criteria spec and read-only annotations is nearly complete for a search tool. The only notable gap is the absence of an output schema or explicit return-field description, so the agent must infer the shape of returned vendor credit records.

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 schema already documents both the company and criteria parameters in exhaustive detail. The one-line tool description adds no parameter-level meaning, so it stays at the schema-covered baseline rather than being elevated.

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 names a specific verb ('Search') and an unambiguous resource ('vendor credit records') scoped to QuickBooks Online. This lets an agent distinguish it from the singular get_vendor_credit and from search_vendors, which target different records.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

There is no explicit statement of when to prefer this tool over get_vendor_credit or other search_* siblings; the only cue is the verb and resource in the description. The criteria parameter documentation does provide operational advice on narrowing filters and paging, but tool-selection exclusions and alternatives are left implicit.

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