Skip to main content
Glama
getsentry

plausible-mcp

by getsentry

Get Breakdown

get_breakdown
Read-onlyIdempotent

Break down Plausible Analytics metrics by dimension such as page, traffic source, country, or device to identify top pages, sources, and segment traffic.

Instructions

Break down metrics by a dimension: page, traffic source, country, device, etc. Use to find top pages, sources, or segment traffic.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pageNoFilter by page path. Exact match by default, use * as trailing wildcard (e.g. /blog*)
limitNoMax results to return
metricsNoMetrics to return. Defaults vary by tool.
site_idYesPlausible site domain (e.g. example.com). Required.
dimensionYesDimension to group results by: a standard dimension (e.g. event:page, visit:source), or a custom event property as "event:props:<name>" (e.g. event:props:plan).
date_rangeYesDate range: "7d", "30d", "12mo", "month", "year", "all", or "YYYY-MM-DD,YYYY-MM-DD"
property_filtersNoFilter results by built-in dimensions or custom event properties, e.g. [{ "property": "visit:channel", "operator": "is", "values": ["Organic Search"] }] or [{ "property": "plan", "values": ["pro"] }]. Entries are combined with AND.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
metricsYesMetric keys, in the order they appear in each row's `metrics` array
resultsYesOne row per dimension-value combination returned by Plausible
dimensionsYesDimension keys, in the order they appear in each row's `dimensions` array

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changedv0.9.0
    • removedOutput schema / properties / results / items / properties / dimensions / items / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "number"
      -  }
      -]
    • addedOutput schema / properties / results / items / properties / dimensions / items / type
      Added value: +[
      +  "string",
      +  "number"
      +]
    • removedOutput schema / properties / results / items / properties / metrics / items / anyOf
      Removed value: -[
      -  {
      -    "type": "number"
      -  },
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / results / items / properties / metrics / items / type
      Added value: +[
      +  "number",
      +  "string",
      +  "null"
      +]
  2. Changed1 schema field changedv0.7.2
    • addedInput schema / properties / property_filters / items / properties / values / items / maxLength
      Added value: +1024
  3. Changed9 schema fields changedv0.7.1
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
    • addedInput schema / properties / dimension / anyOf
      Added value: +[
      +  {
      +    "enum": [
      +      "event:page",
      +      "event:goal",
      +      "event:hostname",
      +      "visit:entry_page",
      +      "visit:exit_page",
      +      "visit:source",
      +      "visit:referrer",
      +      "visit:channel",
      +      "visit:utm_medium",
      +      "visit:utm_source",
      +      "visit:utm_campaign",
      +      "visit:utm_content",
      +      "visit:utm_term",
      +      "visit:device",
      +      "visit:browser",
      +      "visit:browser_version",
      +      "visit:os",
      +      "visit:os_version",
      +      "visit:country",
      +      "visit:region",
      +      "visit:city",
      +      "visit:country_name",
      +      "visit:region_name",
      +      "visit:city_name"
      +    ],
      +    "type": "string"
      +  },
      +  {
      +    "maxLength": 312,
      +    "minLength": 13,
      +    "pattern": "^event:props:",
      +    "type": "string"
      +  }
      +]
    • changedInput schema / properties / dimension / description
      Previous value: -"Dimension to group results by"New value: +"Dimension to group results by: a standard dimension (e.g. event:page, visit:source), or a custom event property as \"event:props:<name>\" (e.g. event:props:plan)."
    • removedInput schema / properties / dimension / enum
      Removed value: -[
      -  "event:page",
      -  "event:goal",
      -  "event:hostname",
      -  "visit:entry_page",
      -  "visit:exit_page",
      -  "visit:source",
      -  "visit:referrer",
      -  "visit:channel",
      -  "visit:utm_medium",
      -  "visit:utm_source",
      -  "visit:utm_campaign",
      -  "visit:utm_content",
      -  "visit:utm_term",
      -  "visit:device",
      -  "visit:browser",
      -  "visit:browser_version",
      -  "visit:os",
      -  "visit:os_version",
      -  "visit:country",
      -  "visit:region",
      -  "visit:city",
      -  "visit:country_name",
      -  "visit:region_name",
      -  "visit:city_name"
      -]
    • removedInput schema / properties / dimension / type
      Removed value: -"string"
    • addedInput schema / properties / property_filters
      Added value: +{
      +  "description": "Filter results by built-in dimensions or custom event properties, e.g. [{ \"property\": \"visit:channel\", \"operator\": \"is\", \"values\": [\"Organic Search\"] }] or [{ \"property\": \"plan\", \"values\": [\"pro\"] }]. Entries are combined with AND.",
      +  "items": {
      +    "properties": {
      +      "operator": {
      +        "default": "is",
      +        "description": "Match operator: is, is_not, contains, contains_not (default: is)",
      +        "enum": [
      +          "is",
      +          "is_not",
      +          "contains",
      +          "contains_not"
      +        ],
      +        "type": "string"
      +      },
      +      "property": {
      +        "description": "What to filter on: a built-in dimension (e.g. \"visit:channel\", \"visit:source\", \"event:page\") or a custom event property as its bare name (e.g. \"plan\" targets event:props:plan)",
      +        "maxLength": 312,
      +        "minLength": 1,
      +        "type": "string"
      +      },
      +      "values": {
      +        "description": "One or more values to match the property against",
      +        "items": {
      +          "type": "string"
      +        },
      +        "minItems": 1,
      +        "type": "array"
      +      }
      +    },
      +    "required": [
      +      "property",
      +      "values"
      +    ],
      +    "type": "object"
      +  },
      +  "type": "array"
      +}
    • changedInput schema / properties / site_id / description
      Previous value: -"Plausible site domain (e.g. example.com). Uses PLAUSIBLE_DEFAULT_SITE_ID if omitted."New value: +"Plausible site domain (e.g. example.com). Required."
    • changedInput schema / required
      Previous value: -[
      -  "date_range",
      -  "dimension"
      -]New value: +[
      +  "site_id",
      +  "date_range",
      +  "dimension"
      +]
    • changedOutput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
  4. First observedv0.5.1

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, and openWorldHint, so the safety profile is covered. The description adds no behavioral context beyond that — nothing about result limits, default metric selection, ordering, or how entries are combined.

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 short sentences, front-loaded with the core action and followed by the use case. No filler, no repetition of the title.

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?

An output schema exists and all 7 parameters are fully described in the schema, so the description need not cover return values. It covers purpose and a use case adequately; only route-to-sibling guidance is absent.

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 100%, so every parameter including dimension enums and format examples is already documented in the schema. The description's dimension examples (page, traffic source, country, device) loosely map to schema values but add no syntax or format detail beyond it. 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 verb+resource (break down metrics by a dimension) and gives concrete example dimensions (page, traffic source, country, device) plus example goals (top pages, sources). It never names or contrasts its siblings (get_timeseries, get_conversions, compare_periods), so it stops short of a 5.

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 to find top pages, sources, or segment traffic' implies the use case but gives no when-not conditions and points to no alternative tool. An agent must infer that breakdown-by-dimension is the right choice over timeseries or comparison, which the description does not address.

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