Skip to main content
Glama

Caribooks (QuickBooks Online)

get profit and loss detail

get_profit_and_loss_detail
Read-only

Generate the QuickBooks profit and loss detail 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); the filters customer, vendor, item, class, department (QuickBooks Ids, comma-separated for several); account, account_type, employee, payment_method; columns (comma-separated, e.g. tx_date,txn_type,doc_num,name,memo,account_name,other_account,due_date,pmt_mthd,is_cleared,dept_name), sort_by (one of those columns), sort_order (ascend|descend).
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.4/5.0
Behavior5/5

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

Beyond the readOnlyHint annotation, the description discloses important runtime behaviors: all-zero rows are omitted and counted in hidden_zero_rows, filters lists only the filters QuickBooks confirmed applying (ignored parameters are absent), and no_data indicates an empty period. This gives an agent reliable expectations for parsing and interpreting results.

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 dense but each sentence carries meaningful detail about return structure, row semantics, hidden rows, filter confirmation, and no_data. It is not a short one-liner, but the complexity of the output deserves this level of specificity; the key purpose is front-loaded and the details are logically ordered.

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 present, the description fully compensates by documenting the complete return shape: columns, column_types, rows with type/depth/values, id alignment, hidden_zero_rows, filters, and no_data. For a report-generation tool with rich output and many sibling report tools, nothing essential is missing for correct invocation and interpretation.

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 parameters are already documented in the schema. The description adds value by explaining that the filters parameter may not appear in the output if QuickBooks ignored it, and it clarifies how values and ids map differently between summary and detail reports. This goes beyond the raw schema definitions.

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 profit and loss detail report') and consistently uses 'detail' to distinguish it from the sibling summary tool get_profit_and_loss. The report structure is also named explicitly, so an agent can tell exactly what this tool produces.

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?

The description implies use for detailed P&L reporting, and the mention of 'summary reports' hints that a summary variant exists, but it never explicitly says when to choose this tool over get_profit_and_loss or other report tools. There is no direct exclusion or alternative routing; the agent must infer usage from the 'detail' naming.

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