Skip to main content
Glama

InvoiceVista Invoice Maker

Summarize invoiced and paid amounts

get_revenue_summary
Read-onlyIdempotent

Use this when someone asks how much they invoiced or were paid in a period, like last month. Returns invoice and payment counts and totals in the business currency, invoices by status and a collection rate; defaults to the last 90 days, at most 366, skipping drafts and counting at most 500 documents. Not for a single invoice or customer.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
endDateNoLast UTC day to include, YYYY-MM-DD, at most 366 days after startDate; defaults to today
startDateNoFirst UTC day to include, YYYY-MM-DD; defaults to 89 days before endDate (a 90-day window)
businessIdYesBusiness id: 24 lowercase hexadecimal characters

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
rangeYes
currencyYesISO 4217 alpha-3 business currency, or null when unset
invoiceCountYes
paymentCountYes
invoicedAmountYes
collectedAmountYesSum of the payments recorded in the range, whatever their status; not proof of bank settlement
collectionRatePercentYescollectedAmount as a percentage of invoicedAmount; null when a total is incomplete or nothing was invoiced
invoiceStatusBreakdownYesNon-draft invoices issued in the range, per status, with count and amount. Aggregates only: invoice, payment, customer, line-item, processor, card, bank, note and identifier data are never returned.
invoiceCountIsLowerBoundYes
paymentCountIsLowerBoundYes
invoiceAmountMissingCountYes
paymentAmountMissingCountYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changed
    • removedInput schema / properties / endDate / $ref
      Removed value: -"#/properties/startDate"
    • addedInput schema / properties / endDate / pattern
      Added value: +"^\\d{4}-\\d{2}-\\d{2}$"
    • addedInput schema / properties / endDate / type
      Added value: +"string"
  2. Changed6 schema fields changed
    • changedInput schema / properties / businessId / description
      Previous value: -"Tenant-owned InvoiceVista business id"New value: +"Business id: 24 lowercase hexadecimal characters"
    • changedInput schema / properties / endDate / description
      Previous value: -"Last UTC day to include; defaults to today"New value: +"Last UTC day to include, YYYY-MM-DD, at most 366 days after startDate; defaults to today"
    • changedInput schema / properties / startDate / description
      Previous value: -"First UTC day to include; defaults to 89 days before endDate"New value: +"First UTC day to include, YYYY-MM-DD; defaults to 89 days before endDate (a 90-day window)"
    • addedOutput schema / properties / collectedAmount / description
      Added value: +"Sum of the payments recorded in the range, whatever their status; not proof of bank settlement"
    • addedOutput schema / properties / collectionRatePercent / description
      Added value: +"collectedAmount as a percentage of invoicedAmount; null when a total is incomplete or nothing was invoiced"
    • addedOutput schema / properties / invoiceStatusBreakdown / description
      Added value: +"Non-draft invoices issued in the range, per status, with count and amount. Aggregates only: invoice, payment, customer, line-item, processor, card, bank, note and identifier data are never returned."
  3. First observed

TDQS

A4.7/5.0
Behavior5/5

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

Annotations already declare readOnly/idempotent/non-destructive, and the description adds real behavioral context beyond them: a default 90-day window, a hard 366-day ceiling, that drafts are skipped, and that at most 500 documents are counted. These are exactly the silent constraints that would otherwise cause a wrong call.

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 sentences, front-loaded with the trigger phrase and followed by the return payload and the scoping limit. No filler, and the exclusion is placed last as a natural boundary.

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 an output schema present, return-value detail is optional, yet the description briefly signals the shape (counts, totals, status breakdown, collection rate). Combined with the default window, caps, draft exclusion, and scope boundary, an agent has everything needed to call it correctly.

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 description coverage is 100%, so the baseline is 3 and the schema already documents businessId, startDate, and endDate formats and defaults. The description nonetheless reinforces the window semantics (default 90 days, cap 366) and adds a non-parameter constraint (500-document counting cap), slightly exceeding the baseline.

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?

States a specific verb and resource ('how much they invoiced or were paid in a period') and enumerates the returned artifacts: invoice and payment counts and totals in business currency, invoices by status, and a collection rate. The closing exclusion ('Not for a single invoice or customer') further sharpens its scope against narrower siblings.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives an explicit trigger ('Use this when someone asks how much they invoiced or were paid in a period, like last month') and an explicit when-not ('Not for a single invoice or customer'). It stops short of naming which sibling to use instead for per-customer or receivables questions, so routing between get_receivables_summary and this tool is left to inference.

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