Skip to main content
Glama
umami-compass

umami-compass

by webcredo

Get pageview and session series

get_pageviews
Read-onlyIdempotent

Retrieve Umami pageview and session time series for a website over a date range, with optional filters, timezone, and interval; both arrays remain in the response.

Instructions

Get Umami 3.2 pageview and session time series. Both arrays are preserved in the response.

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

Input Schema

NameRequiredDescriptionDefault
endYesUnix milliseconds, ISO 8601 with timezone, or YYYY-MM-DD (UTC)
unitNo
startYesUnix milliseconds, ISO 8601 with timezone, or YYYY-MM-DD (UTC)
filtersNo
timezoneNoUTC
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

C2.9/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and openWorldHint, so the safety profile is covered. The only added behavioral fact is that both arrays survive in the response, which is a real but narrow disclosure. Nothing about granularity defaults, timezone handling, or result-size behavior beyond the annotations.

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, front-loaded with the resource and version. No wasted words, though the second sentence about preserving arrays is thin relative to how much remains unsaid.

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

Completeness2/5

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

This is a fairly complex tool: six parameters, three required, a deeply nested filter object, an enum for unit, and an output schema. An output schema does relieve the description of explaining return values, but the unit/timezone semantics and filter usage are left entirely undocumented at 50% schema coverage.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is only 50%, and the description adds nothing about any of the six parameters — not unit, not timezone, not the large nested filters object with its operator forms. For a tool with this much parameter surface, the prose should be compensating and it is not.

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 verb and resource — pageview and session time series from Umami 3.2 — which is more precise than the sibling names like get_metrics or get_website_stats suggest. It does not explicitly contrast itself with compare_traffic_series or get_metrics, so the sibling differentiation is only implicit.

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 when-to-use guidance at all. The description never says to pick this over get_metrics or compare_traffic_series, nor does it mention any prerequisite such as needing a resolved websiteId first, which matters given resolve_website exists as a sibling.

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