Skip to main content
Glama

Overview KPIs

get_overview
Read-onlyIdempotent

Headline numbers for a time range: visitors, visits, page views, bounce rate, time on site, revenue, customers, conversion rate and revenue per visitor, each compared with the previous range of the same length, plus how many people are online now. Use it to answer 'how is the site doing?'.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "get_overview"
  }
}

Input Schema

NameRequiredDescriptionDefault
toNoLast day, inclusive (YYYY-MM-DD).
fromNoFirst day (YYYY-MM-DD, site time zone). Use with to instead of period.
siteNoSite domain (example.com), id or public id (tb_…). Optional with a site key, or when the account has one site.
periodNoTime range. Default 30d. today, yesterday, 24h, 7d, 30d, 90d, 12m, wtd, mtd, ytd, all.
filtersNoOnly visits that match every filter. A value is "is": {"country": "US"}; a list is "is any of": {"country": ["PT", "ES"]}; an object picks the operator: {"page": {"contains": "/blog"}}, {"channel": {"is_not": ["Direct", "Email"]}}, {"page": {"not_contains": "/admin"}}. Operators: is, is_not, contains, not_contains (case-insensitive). "visitor" is "new" or "returning". "ad" is an ad campaign as "google:<campaign id>" or "meta:<campaign id>" (the visits that the Ads page counts for it). Use "(none)" for empty values; countries take ISO codes or English names.

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 cover safety (readOnly, idempotent, non-destructive, closed-world). The description adds real behavioural content beyond them: each metric is compared against the previous range of equal length, and a live 'online now' count is included. It does not mention auth/permission requirements or that the period defaults to 30d, so there is still room.

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?

Two sentences, metric inventory front-loaded followed by the purpose statement, with no filler. Every clause conveys either content or intended use.

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 no output schema, the description does the job of telling the agent what comes back (the nine KPIs, prior-period comparisons, live visitor count), which is exactly the missing piece. The nested filters object is left entirely to the schema, which is acceptable given its 100% coverage, but a one-line note on filterability would have made it complete.

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% — parameters, the period enum, and the complex filters grammar are all documented in the schema. The description adds nothing about the time-range, site selection, or filter semantics, so baseline 3 applies.

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?

States a specific resource (headline KPI numbers) and enumerates exactly which metrics are returned, so an agent knows this is a summary endpoint rather than a drill-down. It doesn't explicitly differentiate itself from siblings like get_breakdown, get_timeseries or get_revenue, but the metric list makes the scope clear.

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?

"Use it to answer 'how is the site doing?'" gives an implied usage context but names no alternatives (e.g. get_breakdown for per-dimension splits, get_timeseries for trends, get_realtime for live visitors) and no exclusions. Adequate but leaves routing to inference.

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