Skip to main content
Glama

Tally by Outpost

Breakdown

get_breakdown
Read-onlyIdempotent

The top values of one dimension (source, channel, page, country, device, campaign …) by distinct visitors, or by revenue, each with its share of visitors and the revenue its visitors brought.

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": {
      "dimension": "<dimension>"
    },
    "name": "get_breakdown"
  }
}

Input Schema

NameRequiredDescriptionDefault
toNoA custom range's last day (YYYY-MM-DD), with from.
fromNoA custom range's first day (YYYY-MM-DD), with to. Up to 366 days, not past today.
siteNoThe site's id. Optional: the API key's site is the one read.
sortNoTop values by visitors (default) or by revenue.
limitNoRows at most (default 10).
periodNoA preset period, in the site's time zone. Leave out for the tool's default, or give from and to instead.
filtersNoVisits that match every filter (AND). Each dimension at most once.
dimensionYesWhat to break down by.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false, and openWorldHint=false, so the safety profile is fully covered. The description adds real value by specifying the returned metrics: distinct visitors, share of visitors, and the revenue those visitors brought. It does not discuss pagination or rate limits, but those are not necessary for a read-only analytics tool with full schema coverage.

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 a single front-loaded sentence that immediately conveys the operation, the metric choices, and the return contents. Every clause earns its place, with no filler or repetition.

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 read-only breakdown tool with a 100% described schema and complete safety annotations, the description is nearly sufficient: it explains what is broken down, the two metric bases, and what each row returns. It does not mention defaults for period or limit, but the schema covers those, so the remaining gap is minor.

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 description coverage is 100%, so all eight parameters are already documented, including enums for dimension, sort, and period, plus the nested filters object. The description adds only marginal meaning, mainly clarifying 'distinct visitors' and giving examples of dimensions that largely repeat the enum. Baseline 3 is appropriate.

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?

The description states a specific resource ('top values of one dimension') and metric basis ('by distinct visitors, or by revenue'), plus what each row contains ('its share of visitors and the revenue its visitors brought'). It is clearly distinct from aggregate siblings like get_overview, though it never names an alternative directly.

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?

Usage is implied by the phrasing 'top values of one dimension' and the dimension examples, which suggest this is the tool for per-dimension breakdowns. However, there is no explicit when-to-use guidance, no when-not guidance, and no named alternative such as compare_periods or get_overview.

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