Skip to main content
Glama
QuickBooks Online MCP Server

QuickBooks Online MCP Server

by NightSquawk

report_vendor_balance

Generates a Vendor Balance Summary report showing outstanding balances by vendor, with date range, accounting method, and filter options for tracking payables.

Instructions

Run a Vendor Balance Summary report showing outstanding balances by vendor. 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_vendor_balance"
  }
}

Input Schema

NameRequiredDescriptionDefault
paramsYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.5/5.0
Behavior3/5

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

No annotations are supplied, so the description must carry the whole behavioral burden. It implies a read-only report and notes the supported dimensions (date range, accounting method, filters), but says nothing about required permissions, the structure of the returned data, row limits, or whether a summarize_column_by choice changes the output shape.

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?

Two short sentences, front-loaded with what the report is, then what it supports. There is no filler, though the second sentence largely restates what the nested schema already shows.

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

Completeness4/5

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

The description covers purpose and scope adequately for a report whose nested params are already documented in the schema. The gaps relative to the sibling detail report and the missing return-value hints keep it from being fully complete.

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 top-level schema exposes only a nested 'params' object with 0% description coverage at that level, so the description's line about date range, accounting method, and filters is the only top-level cue. It does not add any semantics beyond that, and the useful detail (date_macro vs start_date/end_date exclusivity, enum options) lives only in the nested property descriptions.

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 gives a specific verb and resource ('Run a Vendor Balance Summary report') and states what the report contains ('outstanding balances by vendor'), which is clearer than the sibling report_* names alone. It does not, however, explicitly distinguish itself from the close sibling report_vendor_balance_detail, which sits in the same toolset.

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?

Usage is only implied: an agent can infer this is the tool for a per-vendor outstanding-balance view, but there is no explicit guidance on when to pick it over report_vendor_balance_detail, report_aged_payables, or report_vendor_expenses. No prerequisites or exclusions are stated.

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