Skip to main content
Glama

report_payments_vs_invoiced

Compare total invoiced (issued invoices by document date) vs total collected (payments by payment date) per month and currency. Shows collection rate and cash flow gap.

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": "report_payments_vs_invoiced"
  }
}

Input Schema

NameRequiredDescriptionDefault
stateNoDocument state filter: draft, open, closed, cancelled, or the alias "issued" (= open+closed). Defaults to "issued", so draft and cancelled invoices are excluded from the figures. Pass "all" to include every state.
date_toNoEnd date inclusive (YYYY-MM-DD)
currencyNoRestrict to one currency
date_fromNoStart date inclusive (YYYY-MM-DD)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.5/5.0
Behavior3/5

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

No annotations are provided, so the description bears the full burden. It adds useful behavioral detail about the metric definitions (document date vs payment date) and the derived outputs (collection rate, cash flow gap), but does not state that this is a read-only aggregation, the response shape, or any performance considerations.

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 tightly written sentences with zero waste, front-loading the comparison and then the derived outputs. Every clause earns its place.

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 no-output-schema, no-annotation reporting tool with four optional params, the description covers the metric definitions but leaves the return structure, granularity behavior (e.g., empty months), and read-only nature implicit. Adequate but with clear gaps.

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 100% and the schema itself explains the 'issued' alias default and date semantics well. The description reinforces the date-basis distinction (invoiced by document date, collected by payment date), but adds little beyond what the schema already provides, so baseline 3 applies.

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?

States a specific comparative operation: total invoiced (by document date) vs total collected (by payment date), per month and currency. This clearly distinguishes it from single-metric siblings like report_invoiced_by_period or report_vat_collected, though it does not explicitly name those alternatives.

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?

The purpose implies usage (measuring collection rate and cash flow gap over time), but there is no explicit when-to-use guidance, no exclusions, and no routing to the closely related report_outstanding_balances or report_invoiced_by_period siblings.

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