Skip to main content
Glama

Caribooks (QuickBooks Online)

search company currencies

search_company_currencies
Read-only

Search company currency records in QuickBooks Online. The currencies the company transacts in; only meaningful with multicurrency enabled. 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 company_currency 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 and destructiveHint=false, so safety is covered. The description adds real behavioral context beyond that: the multicurrency precondition and the fact that returned records are complete with SyncToken (no follow-up get required). It doesn't mention pagination or rate limits, but those live in the criteria schema.

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?

Front-loaded with the purpose, then scope, precondition, and two practical tips in three compact clauses. No filler, though the final clause about Id IN is slightly dense.

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 read-only search tool with no output schema, it covers purpose, precondition, result shape, and a batching hint, while annotations cover safety and the schema covers pagination/truncation. Nothing critical is missing, though explicit alternative routing would round it out.

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 description is already very rich, so the baseline is 3. The description adds a useful tip not in the schema – batching known Ids via 'Id IN' – which slightly exceeds baseline.

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 company currency records in QuickBooks Online') and clarifies the scope ('the currencies the company transacts in'). It also implicitly differentiates from get_company_currency by noting results are full records with SyncToken, so no follow-up get is needed. It stops short of explicitly naming the sibling to route to, so it lands at 4 rather than 5.

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 clear precondition ('only meaningful with multicurrency enabled') and a practical usage pattern ('read several known Ids in one search with Id IN'). It does not explicitly name when to prefer an alternative like get_company_currency for a single record, so no exclusion/routing guidance.

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