Skip to main content
Glama

StoreMetrics

Get Overview KPIs

get_overview
Read-only

Headline KPIs for a site and range: visitors, pageviews, orders, revenue, AOV, conversion rate, and live visitors now. Response includes a definitions field explaining how each metric is counted.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
siteYesSite handle from list_sites.
rangeNoA preset (today, yesterday, this_week, last_week, this_month, last_month, last_7d, last_14d, last_28d, last_30d, last_90d, all_time) or a custom span "YYYY-MM-DD/YYYY-MM-DD" interpreted in the site's timezone. Defaults to last_30d.

TDQS

A4.3/5.0
Behavior4/5

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

Beyond the readOnlyHint annotation, the description adds that the response includes a `definitions` field explaining metric counting, which helps the agent interpret returned values. It does not address rate limits or auth, but the read-only nature is disclosed.

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 with the primary function front-loaded; no filler.

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?

The tool is a simple read-only query with only two parameters; the schema documents both, and the description enumerates the metrics plus the definitions field. This is sufficient for an agent to invoke it correctly.

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?

Both parameters have full descriptions in the schema (100% coverage), so the description adds no additional parameter meaning. The tool description references 'site and range' but the schema already defines them.

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?

The description specifies a concrete resource (a site and date range) and a clear verb ('get overview') with an explicit list of KPIs (visitors, pageviews, orders, etc.), making it distinct from siblings like get_live or get_funnel which focus on narrower scopes.

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?

It says 'Headline KPIs for a site and range' which clarifies the intended use case as high-level metric retrieval. It doesn't explicitly discuss when not to use it, but the sibling context plus the metric list makes appropriate usage clear.

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.

TDQS

A4/5.0
Disambiguation5/5

Each tool addresses a distinct analytics facet (overview, traffic, geo, audience, pages, funnel, live, weekly report, site context, site list) with no overlapping purposes. An agent can easily choose the right tool based on the question.

Naming Consistency5/5

All tools follow a consistent verb_noun pattern (get_*) except list_sites, which still uses a clear verb_noun structure. The naming is uniform and predictable.

Tool Count5/5

With 10 tools, the set is well-scoped for an analytics server, covering both summary and breakdown views without unnecessary bloat. Each tool earns its place.

Completeness4/5

The tool set covers core analytics needs: overview, traffic sources, audience, geo, pages, funnel, live, and weekly comparisons. Minor gaps like custom date ranges or event detail drill-downs are not critical for standard store analytics.

Resources