Skip to main content
Glama

Breakdown

get_breakdown_compared
Read-onlyIdempotent

Top values of a dimension: channel, referrer, campaign, page, country, device and more. With previous set to 1, the period before too, to compare.

Input Schema

NameRequiredDescriptionDefault
toNoEnd date, inclusive (YYYY-MM-DD), for period custom
dimNoThe dimension to read by, e.g. channel, source_detail, page, country
fromNoStart date (YYYY-MM-DD), for period custom
sortNoWhat to sort by
limitNoHow many rows
modelNoRevenue attribution model (defaults to the website's)
periodNoDate range in the website's timezone, as on the dashboard: today, 24h, 7d, 30d (default), 90d, 12m, mtd, lastmonth, ytd, all, custom…
searchNoOnly rows containing this
filtersNoFilters, each [dimension, operator, value], e.g. [["country","is","US"]]
websiteYesWebsite id or domain, e.g. example.com (see list_websites)
previousNoSet to 1 to add the period before, to compare

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3.2/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false and a closed-world scope, so the safety profile is fully covered. The description adds only that setting `previous`=1 extends the read to the preceding period; it says nothing about row ordering, pagination, or what metrics accompany each dimension value.

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?

Two short sentences, with the core purpose front-loaded and the comparison behavior second. Slightly redundant with the schema's own `previous` description, but nothing is padded or buried.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For an 11-parameter analytics tool with no output schema, the description leaves a meaningful gap: it never says which metrics (visitors, revenue, conversions) accompany each dimension row, nor how comparison results are shaped. The safety and parameter sides are well covered by annotations and the schema, but the return-value side is not.

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 every parameter including `previous`, `dim`, `period`, and `filters` is already documented in structured form. The description's mention of `previous` set to 1 merely restates the schema text and adds no new meaning such as how comparison rows are labeled or what extra fields appear.

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 concrete resource — the top values of a chosen dimension — and lists example dimensions (channel, referrer, campaign, page, country, device), so an agent knows what comes back. It never names the closely related sibling get_breakdown, so the differentiating feature (comparison against a prior period) is only implied via the `previous` parameter note.

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?

There is no explicit when-to-use guidance and no exclusions. With a sibling literally named get_breakdown, the agent must infer from the parameter note alone that this is the comparison variant; the description should say 'use get_breakdown for a single period' but does not.

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