Skip to main content
Glama

Get Daily Volume

get_daily_volume

Returns the total payment volume for a given date, with breakdowns by network and currency. Only counts FILLED (completed) payments. Defaults to today if no date is specified.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
dateNoDate in YYYY-MM-DD format. Defaults to today (UTC).
externalPlatformIdNoOptional. Auto-discovered from your account if omitted.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
dateYes
byNetworkYes
byCurrencyYes
totalPaymentsYes
totalVolumeUSDYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed5 schema fields changed
    • removedOutput schema / properties / byCurrency / items / $ref
      Removed value: -"#/properties/byNetwork/items"
    • addedOutput schema / properties / byCurrency / items / additionalProperties
      Added value: +false
    • addedOutput schema / properties / byCurrency / items / properties
      Added value: +{
      +  "count": {
      +    "type": "number"
      +  },
      +  "name": {
      +    "type": "string"
      +  },
      +  "volumeUSD": {
      +    "type": "number"
      +  }
      +}
    • addedOutput schema / properties / byCurrency / items / required
      Added value: +[
      +  "name",
      +  "count",
      +  "volumeUSD"
      +]
    • addedOutput schema / properties / byCurrency / items / type
      Added value: +"object"
  2. Changed1 schema field changed
    • changedInput schema / properties / externalPlatformId / description
      Previous value: -"External platform ID. Falls back to PAYRAM_EXTERNAL_PLATFORM_ID env var."New value: +"Optional. Auto-discovered from your account if omitted."
  3. Added

TDQS

A3.8/5.0
Behavior3/5

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. It discloses the key filter of only counting FILLED payments and the date default behavior. It does not mention rate limits, auth requirements, or error handling, but for a read-only aggregate query, this is a reasonable amount of disclosure. A score of 3 reflects that it adds meaningful behavioral context but not exhaustive details.

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?

The description is two sentences with no redundancy. The main action and the critical qualifier (FILLED only) are front-loaded, making it clear and scannable. Every sentence earns its place.

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?

Given that an output schema exists, the description need not explain return formats. It covers the core behavior (aggregated volume, date default, filtering) and the parameters are fully documented in the schema. It could add a note on timezone handling or what 'volume' sums, but these are minor gaps, so it is sufficiently complete for a straightforward read tool.

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 input schema already documents both parameters with 100% coverage, including the default for 'date' and the auto-discovery of 'externalPlatformId'. The description adds no additional semantic detail beyond what the schema already provides, so the baseline of 3 applies.

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 clearly states the tool returns total payment volume for a specified date, with breakdowns by network and currency, and explicitly notes it only counts FILLED payments. This is specific and distinguishes it from sibling tools like lookup_payment or search_payments, which likely return individual transaction details rather than aggregated volume.

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 description implies usage for querying daily volume with an optional date, and mentions that it defaults to today. However, it does not explicitly state when to prefer this tool over alternatives such as get_payment_summary or get_unswept_balances, nor does it provide exclusions or prerequisites. Thus, the usage context is clear but not fully articulated.

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