Skip to main content
Glama
umami-compass

umami-compass

by webcredo

Get website statistics

get_website_stats
Read-onlyIdempotent

Retrieve website analytics for a time range, including visits, visitors, pageviews, bounces, visit duration, and Umami comparison values; apply filters to narrow results.

Instructions

Get visits, visitors, pageviews, bounces, visit duration and Umami's comparison values for a time range.

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": {
      "websiteId": "<websiteId>",
      "start": "<start>",
      "end": "<end>"
    },
    "name": "get_website_stats"
  }
}

Input Schema

NameRequiredDescriptionDefault
endYesUnix milliseconds, ISO 8601 with timezone, or YYYY-MM-DD (UTC)
startYesUnix milliseconds, ISO 8601 with timezone, or YYYY-MM-DD (UTC)
filtersNo
websiteIdYesUmami UUID

Output Schema

NameRequiredDescriptionDefault
dataYes
metaYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changedv0.5.2
    • addedOutput schema / properties / meta / properties / responseTruncated
      Added value: +{
      +  "type": "boolean"
      +}
    • addedOutput schema / properties / meta / properties / sectionsTruncated
      Added value: +{
      +  "items": {
      +    "type": "string"
      +  },
      +  "type": "array"
      +}
    • changedOutput schema / properties / meta / required
      Previous value: -[
      -  "dataStatus",
      -  "truncated"
      -]New value: +[
      +  "dataStatus",
      +  "truncated",
      +  "responseTruncated",
      +  "sectionsTruncated"
      +]
  2. First observedv0.4.1

TDQS

B3.2/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, non-destructive and openWorld, so the safety profile is fully covered by structured data. The description adds one piece of genuine value beyond that: it discloses that comparison values are included in the result, which hints at the response shape. It says nothing about the large filters object, result cardinality, or how the comparison baseline is chosen.

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?

A single dense sentence with the metric list front-loaded and zero filler. The phrase "Umami's comparison values" is somewhat jargon-heavy and would benefit from a word of clarification, but nothing is wasteful.

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?

An output schema exists, so return values needn't be explained, and annotations cover the safety profile. However, for a tool with a 4-parameter schema dominated by an elaborate nested filters object, the description leaves the most complex parameter entirely unexplained, which is a real gap for correct invocation.

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 coverage is 75%, so the baseline is 3, and the start/end semantics are already fully documented in the schema (Unix ms, ISO 8601, or YYYY-MM-DD). The description's "for a time range" merely restates that. Critically, the `filters` parameter — a deeply nested object with dozens of dimensions, an operator enum, and match/excludeBounce — receives no mention at all in the description.

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 names a specific verb (get) plus the exact resource and enumerates the metric family returned: visits, visitors, pageviews, bounces, visit duration, comparison values. That is far more informative than the title alone. It does not, however, distinguish itself from siblings such as get_metrics or get_pageviews, which appear to cover overlapping metric territory.

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?

"for a time range" is the only usage signal, and it is implied context rather than guidance. The description never says when to prefer this over get_metrics, get_pageviews, or get_website_date_range, nor does it give exclusions or prerequisites (e.g., that a websiteId must be resolved first via resolve_website).

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.