unified-pay-cli

get_payment_analytics

Aggregate real-time transaction performance across payment gateways. Get total gross volume, captured revenue, settled payouts, and success/conversion rates from recent histories for statistical insights.

Instructions

Aggregates real-time transaction performance, total gross volume, captured revenue volume, settled payouts, and payment success/conversion rates by querying recent transaction histories across connected payment gateway accounts. Returns statistical aggregates and settlement ratios.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "provider": "<provider>"
    },
    "name": "get_payment_analytics"
  }
}

Input Schema

Name	Required	Description	Default
`limit`	No	The maximum number of recent historical transaction records to retrieve and analyze (integer between 1 and 100, default: 50).
`provider`	Yes	The target payment gateway account from which to fetch charge histories and calculate performance metrics.

Schema Changelog

Changes observed during successful MCP inspections.

Changed2 schema fields changedv0.1.3Aug 19, 2026

changedInput schema / properties / limit / description

Previous value: -"Number of recent charges to analyze"New value: +"The maximum number of recent historical transaction records to retrieve and analyze (integer between 1 and 100, default: 50)."

addedInput schema / properties / provider / description

Added value: +"The target payment gateway account from which to fetch charge histories and calculate performance metrics."

First observedv0.1.2Aug 19, 2026

TDQS

A3.6/5.0

Behavior3/5

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

With no annotations provided, the description must convey behavioral transparency. It states the tool returns aggregates and settlement ratios, implying a read-only operation, but it does not explicitly mention safety, side effects, or any requirements. It adds some context (real-time, recent histories) but lacks explicit safety guarantees.

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, front-loads the core function, and contains no redundant information. Every phrase adds value, making it concise and well-structured.

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?

For a simple read-oriented analytics tool with only 2 parameters and no output schema, the description covers the purpose, key inputs (implicitly), and output. It lacks explicit caveats or limitations but is otherwise sufficient for an agent to invoke correctly.

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 provides 100% coverage for both parameters (provider and limit), including clear descriptions and an enum for provider. The tool description adds minimal extra meaning beyond the schema, mostly integrating the parameters into the overall narrative. Per the rubric, with high schema coverage, the baseline is 3.

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 action (aggregates) and the resource (transaction performance metrics across payment gateway accounts), with specific metrics listed. This distinguishes it from sibling tools like compare_gateway_fees (which focuses on fee comparison) and create_payment_link (which creates links).

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

Usage Guidelines2/5

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

The description provides no explicit guidance on when to use this tool over alternatives. It does not mention any exclusions, prerequisites, or alternative tools. The intended use case is only implied by the function name and description.

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

Deploy Server