Skip to main content
Glama

Caribooks (QuickBooks Online)

get vendor balance

get_vendor_balance
Read-only

Generate the QuickBooks vendor balance report. Returns { columns, column_types, rows }: each row has a type (section | data | total), a depth, and values aligned to columns (Money cells as numbers, first cell is the label on summary reports); id is the label cell's QuickBooks record id (e.g. the account); on detail reports ids aligns to values instead. All-zero rows are omitted and counted in hidden_zero_rows. filters lists the filters QuickBooks confirms it applied (a parameter it ignored is absent), and no_data: true means the period has nothing to report.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
paramsNoQuickBooks report query parameters: report_date (YYYY-MM-DD, the as-of date; defaults to today) or date_macro (Today, Yesterday, This Week, Last Week, This Month, Last Month, This Month-to-date, This Fiscal Quarter, Last Fiscal Quarter, This Fiscal Year, Last Fiscal Year, This Fiscal Year-to-date, Last Fiscal Year-to-date, ...); accounting_method (Cash|Accrual); summarize_column_by (Total|Month|Quarter|Year|Week|Days|Classes|Departments|Customers|Vendors|Employees|ProductsAndServices); vendor, department, appaid (All|Paid|Unpaid).
companyNoWhich connected QuickBooks company to use (name, realm id, or connection id). Optional when only one company is connected.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4/5.0
Behavior5/5

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

The description goes well beyond the annotations by explaining the exact return structure, row types, id alignment rules, hidden_zero_rows behavior, filter confirmation semantics, and no_data flag. It adds substantial behavioral context without contradicting the readOnlyHint and destructiveHint annotations.

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 description is dense but front-loaded with the core verb and resource, and every sentence contributes to call correctness or result interpretation. Despite its length, there is no filler or redundancy.

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?

With no output schema, the description fully compensates by documenting exactly what the tool returns: columns, column_types, rows, row types, depth, id alignment, hidden_zero_rows, filters, and no_data. It also addresses edge cases like ignored parameters and empty periods, making the tool safe to invoke correctly.

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%, so the baseline is 3, but the description adds meaningful parameter behavior: 'filters lists the filters QuickBooks confirms it applied (a parameter it ignored is absent)' clarifies how ignored vendor/department parameters surface in the result. It also explains no_data in relation to the report period, going beyond the schema's value lists.

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?

The description states a specific verb and resource: 'Generate the QuickBooks vendor balance report.' It clearly identifies the tool's function, though it does not explicitly differentiate it from close siblings like get_vendor_balance_detail or get_aged_payables, so it stops short of a 5.

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

Usage Guidelines2/5

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

There is no guidance on when to use this tool versus alternatives such as get_vendor_balance_detail or get_aged_payables. The description implies this is a summary-level report through row types, but it never states the selection criteria or exclusions.

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