Skip to main content
Glama

invoicevista

Get aggregate revenue summary

get_revenue_summary
Read-onlyIdempotent

Summarize invoice production and recorded payments for one tenant-owned business over at most 366 UTC days. Returns aggregate counts and amounts only—never invoice, payment, customer, line-item, processor, card, bank, note, or identifier data. It cannot execute or advise on a financial transaction.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
endDateNoLast UTC day to include; defaults to today
startDateNoFirst UTC day to include; defaults to 89 days before endDate
businessIdYesTenant-owned InvoiceVista business id

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
rangeYes
currencyYesISO 4217 alpha-3 business currency, or null when unset
invoiceCountYes
paymentCountYes
invoicedAmountYes
collectedAmountYes
collectionRatePercentYes
invoiceStatusBreakdownYes
invoiceCountIsLowerBoundYes
paymentCountIsLowerBoundYes
invoiceAmountMissingCountYes
paymentAmountMissingCountYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already establish readOnly/idempotent/non-destructive behavior, so the bar is lower. The description adds valuable boundaries beyond those annotations: it explicitly excludes invoice, payment, customer, and identifier data, and states that it cannot execute or advise on a financial transaction.

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?

Three tightly written sentences with no filler. The main function is front-loaded, followed by data-boundary and safety clarifications, each earning its place.

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?

For a read-only summary tool with a rich output schema and full parameter descriptions, the definition covers scope, date-window limits, aggregate-only behavior, and the non-transaction boundary. There is no missing operational detail that would prevent correct invocation.

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 schema already documents businessId, startDate, and endDate. The description adds operational semantics by constraining the range to at most 366 UTC days and clarifying that businessId is a tenant-owned business, improving selection and invocation without repeating parameter 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 uses a specific verb/resource pair, 'Summarize invoice production and recorded payments,' and narrows scope to one tenant-owned business over a bounded UTC date range. It further distinguishes itself from sibling detail tools by stating it returns aggregate counts and amounts only, never item-level or identifier data.

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?

The description conveys a clear context: use it for aggregate revenue summaries over a date window, not for itemized data or executing financial transactions. It does not name sibling tools like get_receivables_summary or get_quote_pipeline_summary explicitly, so the alternatives are implied rather than spelled out.

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