Skip to main content
Glama
QuickBooks Online MCP Server

QuickBooks Online MCP Server

by NightSquawk

report_customer_balance_detail

Generates a Customer Balance Detail report listing open transactions per customer, with date range, accounting method, and filter options.

Instructions

Run a Customer Balance Detail report showing individual open transactions per customer. Supports date range, accounting method, and filters.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "params": "<params>"
    },
    "name": "report_customer_balance_detail"
  }
}

Input Schema

NameRequiredDescriptionDefault
paramsYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.4/5.0
Behavior3/5

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

No annotations are supplied, so the description carries the full burden. It does disclose meaningful behavior beyond the name — the report lists individual open transactions per customer rather than aggregates — but says nothing about read-only nature, permission requirements, row limits, pagination, or how large results are returned.

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?

Two short sentences, front-loaded with the report identity and followed by the supported input dimensions. Nothing is repeated and nothing is padding.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a report tool with no annotations and no output schema, the definition covers what the report is but not what comes back — no mention of returned columns, row granularity expectations, or result-size behavior. An agent could invoke it correctly, but could not predict or explain the output.

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?

Top-level schema coverage registers as 0% because the single required 'params' wrapper object is undocumented, but the nested properties are individually described in the schema, and the description correctly signals the three families of input (date range, accounting method, filters). It adds no syntax or interaction detail beyond that, so it is a light complement to an otherwise self-documenting nested schema rather than a substitute for it.

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 names a specific verb and resource ('Run a Customer Balance Detail report') and adds scope ('individual open transactions per customer'), which separates it from the summary-level report_customer_balance. It never explicitly names that sibling or the aged-receivable reports, so the differentiation is implied rather than stated.

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 when-to-use or when-not-to-use guidance despite dozens of sibling report tools (report_customer_balance, report_aged_receivables, report_transaction_list_by_customer) that an agent could easily confuse with this one. 'Supports date range, accounting method, and filters' describes capability, not selection criteria or prerequisites.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools