Skip to main content
Glama

Caribooks (QuickBooks Online)

get item sales

get_item_sales
Read-only

Generate the QuickBooks item sales 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: start_date, end_date (YYYY-MM-DD) 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); the filters customer, vendor, item, class, department (QuickBooks Ids, comma-separated for several); start_duedate, end_duedate (YYYY-MM-DD).
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 discloses a wealth of behavioral detail beyond the annotations: the exact return structure (columns, column_types, rows), row semantics (section/data/total, depth, values alignment), ID alignment behavior, handling of all-zero rows via hidden_zero_rows, the filters field reflecting applied parameters, and the no_data flag. This goes far beyond the readOnlyHint and destructiveHint annotations and provides critical operational context.

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 front-loaded with the purpose and then provides a dense but structured explanation of the output. It is one long sentence plus a brief final clause, but it packs a large amount of necessary information without redundancy. It could be more concise, but the structure is logical and efficient.

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 explains the expected return value: columns, rows, types, depth, ID alignment, hidden zero rows, filters, and the no_data flag. It covers edge cases and the meaning of each field, making the tool effectively usable without needing to guess at the response format.

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?

The schema description covers 100% of parameters with detailed explanations for start_date, end_date, date_macro, accounting_method, summarize_column_by, filters, and company. The tool description adds no parameter-level meaning, so a baseline 3 is appropriate given the schema already does the heavy lifting.

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 the tool generates the QuickBooks item sales report, which is a specific verb and resource that distinguishes it from sibling sales reports like customer sales or department sales. Though it doesn't explicitly name alternatives, the resource is unambiguous and the phrase 'item sales report' is distinct.

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?

The description provides no guidance on when to use this tool versus other sales report tools. It only states what it does, without mentioning exclusions, alternatives, or the typical scenario for which it is intended. Among many sibling sales reports, an agent gets no help selecting this one.

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