Skip to main content
Glama

Traffic overview

get_overview
Read-onlyIdempotent

Headline numbers for a window: visits, pageviews, events, bounce rate, visit duration and pages per visit, each against the previous window of equal length. detailed also returns the top 5 pages, sources, countries and devices, which answers most "how is the site doing" questions in one call.

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_overview"
  }
}

Input Schema

NameRequiredDescriptionDefault
toNoLast day, inclusive, YYYY-MM-DD; default today
fromNoFirst day, YYYY-MM-DD; overrides period
detailNodetailed adds columns and splits; concise costs fewer tokensconcise
periodNoWindow ending now; days are whole days in the timezone. Ignored when from is set.30d
filtersNoKeep only matching traffic; values of one dimension are OR-ed, dimensions AND-ed
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.1/5.0
Behavior4/5

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

Beyond the read-only and idempotent annotations, it discloses the previous-window comparison behavior and the additional top-5 results returned by detailed mode. The 'one call' framing also usefully conveys that this is a consolidated overview rather than a sequence of metric requests.

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 compact sentences front-load the core metrics, then explain comparison behavior, detailed output, and the primary use case. There is no filler or repetition of parameter defaults and formats already present in the schema.

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 seven-parameter tool with a fully documented schema and clear safety annotations, this supplies the essential selection and result-shape context, especially because there is no output schema. Its main remaining gap is explicit routing to sibling tools for narrower or more specialized questions.

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 description coverage is 100%, so the parameters are already well documented. The description nevertheless adds value by specifying that detailed returns exactly the top 5 pages, sources, countries, and devices, which is more informative than the schema's generic 'adds columns and splits.'

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 clearly identifies a traffic-summary resource and enumerates its headline metrics, including their comparison against an equal-length previous window. The top-5 breakdowns in detailed mode further clarify its scope, although differentiation from siblings such as get_breakdown and get_timeseries remains implicit.

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 phrase 'how is the site doing' gives a concrete use case, and the explanation of detailed mode helps agents choose it when top pages, sources, countries, or devices are needed. It does not state when to prefer get_realtime, get_timeseries, or get_breakdown for current activity, trends, or deeper analysis.

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