Skip to main content
Glama

Scribe Mail

Analytics — conversions & revenue (aggregated events)

get_analytics_events_summary
Read-onlyIdempotent

Aggregated conversion/revenue numbers from recorded events. By DEFAULT a timeseries of event count + sum of value bucketed by granularity: { data:[{period, count, value}], totals:{count, value} }. Set group_by (name | signature_template | marketing_campaign | teammate | anchor | country | currency | user) for a ranked breakdown: { data:[{id, label, count, value}], pagination } — rank by order_by (count | value). value is summed across currencies, so pass currency or group_by=currency for a clean total. Answers total revenue, revenue by campaign/template/teammate/country, conversions per day, top customers (group_by=user).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameNoRestrict to one event name (e.g. `purchase`).
pageNo1-based page (breakdown only).
limitNoPage size 1–100 (breakdown only).
orderNoSort direction. Default desc.
contextYesExplain in 15-25 words, in third person, why this tool is called and how it supports the user's goal. For analytics only. You MUST describe only the abstract purpose of the tool call. NEVER include, repeat, paraphrase, or infer personal, sensitive, or identifying information from the user request or tool results, including names, emails, phone numbers, IPs, IDs, or credentials. You MUST generalize specific entities into roles such as "a user", "the customer", or "an account". Example: "Retrieving a customer's recent orders to investigate a billing issue and help support determine the appropriate resolution."
countryNoRestrict to one country (ISO 3166-1 alpha-2).
currencyNoRestrict to one currency (e.g. `USD`) for a clean sum.
end_dateNoRange end (inclusive), ISO-8601 date YYYY-MM-DD. Default: today.
group_byNoRanked breakdown by dimension instead of a timeseries: name | signature_template | marketing_campaign | teammate | anchor | country | currency | user.
order_byNoBreakdown ranking metric: count | value (default count).
start_dateNoRange start (inclusive), ISO-8601 date YYYY-MM-DD. Default: 2 months ago.
distinct_idNoRestrict to one identified visitor (their user id).
granularityNoTimeseries bucket size (default day). Ignored when `group_by` is set.
teammate_idNoRestrict to one teammate (their UUID).
marketing_campaign_idNoRestrict to one marketing campaign (its UUID).
signature_template_idNoRestrict to one signature template (its UUID).

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already declare readOnly/idempotent/destructive=false, so the description's job is to add nuance, which it does: the multi-currency warning ('value is summed across currencies, so pass currency or group_by=currency for a clean total') and the rule that granularity is ignored when group_by is set are genuine behavioural disclosures beyond the annotations. It stops short of permissions, rate limits, or data-freshness notes.

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?

Three dense sentences, but front-loaded with the default behaviour and output shape before the optional breakdown path, and every clause carries information (output shapes, currency caveat, use cases). Slightly long, yet nothing is padding.

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 16-parameter tool with an output schema and rich annotations, the description covers the two operating modes, the shape returned by each, the key caveat, and representative questions it answers. Nothing an agent needs in order to call it correctly appears to be missing.

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 baseline is 3, and the description exceeds it by explaining relationships the schema states only locally: granularity's default of day and its being ignored under group_by, the default ranking metric for order_by, and how currency interacts with the summed value. It adds cross-parameter meaning rather than repeating field 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?

States a specific verb and resource ('Aggregated conversion/revenue numbers from recorded events') and immediately distinguishes its output shape from the sibling list_analytics_events / get_analytics_clicks / get_analytics_views by declaring both the default timeseries and the group_by breakdown modes. An agent can tell what this returns without opening the schema.

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 'Answers total revenue, revenue by campaign/template/teammate/country, conversions per day, top customers' clause gives strong positive usage cues, and it explains the mode switch (default vs group_by) that selects behaviour. It does not, however, name or exclude the adjacent analytics siblings, so the routing is implied rather than explicit.

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.