Skip to main content
Glama

Caribooks (QuickBooks Online)

get budget vs actuals

get_budget_vs_actuals
Read-only

Generate the QuickBooks budget vs actuals 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. All four are required: budget (a Budget Id, from search_budgets), start_date, end_date (YYYY-MM-DD) and rowaxis ('primary' for accounts). Optional: summarize_column_by (Total|Month|Quarter|Year|Classes|Departments|Customers), accounting_method (Cash|Accrual). QuickBooks answers 'Permission Denied' when the budget id is missing or unknown, so read it with search_budgets first.
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/5.0
Behavior5/5

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

The description goes well beyond the readOnlyHint annotation, disclosing the exact return shape, row types, depth, value alignment, Money-cell handling, label id behavior, omitted zero rows with hidden_zero_rows, filter confirmation semantics, and the no_data flag. This is exemplary transparency for an agent invoking the tool.

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 every sentence carries meaningful behavioral or usage information. It front-loads the report purpose and then efficiently packs return format, edge cases, filter semantics, and no-data handling without redundancy or filler.

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?

Given the tool's complexity and absence of an output schema, the description is remarkably complete. It covers return shape, row/value semantics, ignored-parameter detection via filters, zero-row handling, no-data behavior, required parameters, and the prerequisite search_budgets call. An agent has everything needed to invoke it correctly and interpret its response.

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%, so the schema already documents all parameters and their requirements. The tool description itself mostly explains output behavior rather than adding new parameter semantics. It reinforces the budget id prerequisite and error behavior, but those details already appear in the schema description, so the description adds no significant beyond-schema parameter 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 opens with a specific verb and resource: 'Generate the QuickBooks budget vs actuals report.' This clearly differentiates the tool from siblings like get_budget, get_cash_flow, and the other report getters, with no ambiguity about what the report contains.

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 gives strong context: required parameters, date formats, rowaxis expectations, and the prerequisite to use search_budgets first to obtain a valid budget id. It also warns about the 'Permission Denied' behavior when the budget id is missing or unknown. It does not explicitly name an alternative tool or state when not to use it, but the context is clear and actionable.

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