ledger-mcp

vendor_balances

Retrieve billed, paid, and open balance totals per vendor, optionally filtered by currency, to spot mismatched-currency payments left open.

Instructions

Billed, paid and open balance per vendor, optionally filtered by currency.

Payments are counted in the vendor's own currency only, so a payment sent in the wrong currency shows up as an open balance (and as an exception in reconcile_ledger).

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

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

Input Schema

Name	Required	Description	Default
`currency`	No

Output Schema

Name	Required	Description	Default
`result`	Yes

Schema Changelog

Changes observed during successful MCP inspections.

First observedv0.1.0Oct 2, 2026

TDQS

A3.8/5.0

Behavior4/5

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

With no annotations, the description carries the full burden and does disclose a non-obvious behavioral rule: payments are matched only in the vendor's own currency, so a mismatched-currency payment surfaces as an open balance. This is exactly the kind of semantic caveat structured fields cannot convey, though it does not state read-only nature or any rate/latency characteristics.

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 tight sentences with the core output front-loaded and the caveat second; no filler, and the exception cross-reference to reconcile_ledger is placed where it is most useful.

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?

An output schema exists, so return formatting is covered elsewhere, and the description supplies the key semantic gotcha an agent needs. Only the read-only nature and the precise meaning of the currency filter remain unstated.

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 coverage is 0% and the single currency parameter's enum is nested inside an anyOf, so the schema adds little prose. The description says the filter is optional, implying null means all currencies, but does not clarify what the filter actually constrains (vendor rows vs payments) given the currency-matching rule above.

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 states the resource (vendor) and the exact measures returned (billed, paid, open balance), which is specific enough to distinguish it from a generic query tool. It does not, however, explicitly differentiate itself from run_sql, the closest sibling for ad-hoc queries.

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?

'Optionally filtered by currency' and the note about wrong-currency payments imply the reconciliation use case, but there is no explicit statement of when to choose this over run_sql or reconcile_ledger. Usage is inferable but not spelled out.

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

Deploy Server