Skip to main content
Glama

Revenue

get_revenue
Read-onlyIdempotent

Gross, refunds, fees and net revenue with charge counts and the change against the previous window, in the site's reporting currency. show daily gives net revenue per day; show by_source splits it by the source of the visit behind each payment, with what could not be attributed; show transactions lists the latest charges, refunds and disputes (a paid plan feature). Needs a connected payment provider.

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": {
      "site_id": "<site_id>"
    },
    "name": "get_revenue"
  }
}

Input Schema

NameRequiredDescriptionDefault
toNoLast day, inclusive, YYYY-MM-DD; default today
fromNoFirst day, YYYY-MM-DD; overrides period
showNosummary
limitNoTransactions to list, at most 100
periodNoWindow ending now; days are whole days in the timezone. Ignored when from is set.30d
site_idYessite_id from list_sites; a site name, slug or domain also resolves
timezoneNoIANA zone for day boundaries; default the user's

Schema Changelog

Changes observed during successful MCP inspections.

No schema history has been recorded yet.

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already declare readOnly/idempotent/non-destructive/closed-world, so the safety profile is covered. The description adds real context beyond them: results are in the site's reporting currency, by_source surfaces unattributed payments, and the tool requires a connected payment provider (with transactions gated behind a paid plan). It doesn't state what happens when no provider is connected or how large result sets behave.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loaded with the headline metrics, then mode semantics, then prerequisites — a logical order with no filler sentences. It is a single dense run-on paragraph, which slightly hurts scannability but wastes no words.

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?

With seven parameters, no output schema, and high schema coverage, the description covers what's not in structured data: mode semantics, currency, attribution caveats, and the payment-provider prerequisite. Return shapes for the summary mode and behavior on missing provider connections are the remaining gaps.

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 86%, so baseline would be 3, but the description supplies the missing semantics for the `show` enum values, which the schema leaves bare, and clarifies that by_source includes unattributable amounts. It adds meaning beyond the schema rather than restating it.

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?

Names the concrete resource and metrics returned (gross, refunds, fees, net revenue, charge counts, change vs previous window) plus the currency basis, so an agent knows exactly what this yields. It is clearly distinguishable from generic siblings like get_overview, get_breakdown, and get_timeseries because it is revenue-specific, and the show modes are enumerated.

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?

"show daily gives net revenue per day; show by_source splits it by the source...; show transactions lists the latest charges..." effectively tells the agent which mode to pick for which need, and it flags that transactions is a paid plan feature. What's missing is guidance on when to prefer this over siblings such as get_breakdown or get_overview for revenue slicing.

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