Skip to main content
Glama
Sign In
plausible-mcp

plausible-mcp

by getsentry
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

Compare Periods

compare_periods
Read-onlyIdempotent

Compare metrics between two date ranges side by side to analyze before/after changes or deploys. Set a baseline and measure deltas and percent change against it.

Instructions

Compare metrics between two date ranges side by side. Ideal for before/after deploy analysis. period_a is the baseline and period_b is measured against it: deltas are period_b minus period_a, and percent is relative to period_a. To see how the current period changed from a prior one, pass the prior range as period_a and the current range as period_b.

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>",
      "period_a": "<period_a>",
      "period_b": "<period_b>"
    },
    "name": "compare_periods"
  }
}

Input Schema

NameRequiredDescriptionDefault
goalNoFilter by goal name (e.g. Signup, Purchase). Do not also target event:goal in property_filters; the call is rejected.
pageNoFilter by page path. Exact match by default, use * as trailing wildcard (e.g. /blog*). Do not also target event:page in property_filters; the call is rejected.
metricsNoMetrics to return. Defaults vary by tool. Plausible rejects these combinations: bounce_rate or visit_duration with event:goal or event:props:<name> dimensions; pageviews, events, scroll_depth or time_on_page with visit:entry_page or visit:exit_page dimensions; views_per_visit with any non-time dimension or a page filter. For goal conversions use get_conversions.
site_idYesPlausible site domain (e.g. example.com). Required.
period_aYesBaseline ("before") date range that deltas are measured from, e.g. "2024-01-01,2024-01-07". For a current-vs-prior comparison, this is the prior range.
period_bYesDate range compared against period_a ("after"), e.g. "2024-01-08,2024-01-14". For a current-vs-prior comparison, this is the current range.
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

NameRequiredDescriptionDefault
deltasYesPer-metric change from period_a (baseline) to period_b: absolute is period_b - period_a, percent is that change relative to period_a. A positive value means period_b is higher.
period_aYes
period_bYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.12.2
    • addedInput schema / additionalProperties
      Added value: +false
  2. Changed3 schema fields changedv0.11.3
    • changedInput schema / properties / period_a / description
      Previous value: -"First date range, e.g. \"2024-01-01,2024-01-07\" or \"7d\""New value: +"Baseline (\"before\") date range that deltas are measured from, e.g. \"2024-01-01,2024-01-07\". For a current-vs-prior comparison, this is the prior range."
    • changedInput schema / properties / period_b / description
      Previous value: -"Second date range, e.g. \"2024-01-08,2024-01-14\" or \"7d\""New value: +"Date range compared against period_a (\"after\"), e.g. \"2024-01-08,2024-01-14\". For a current-vs-prior comparison, this is the current range."
    • changedOutput schema / properties / deltas / description
      Previous value: -"Per-metric change from period_a to period_b (absolute and percent)"New value: +"Per-metric change from period_a (baseline) to period_b: absolute is period_b - period_a, percent is that change relative to period_a. A positive value means period_b is higher."
  3. Changed5 schema fields changedv0.10.0
    • changedInput schema / properties / goal / description
      Previous value: -"Filter by goal name (e.g. Signup, Purchase)"New value: +"Filter by goal name (e.g. Signup, Purchase). Do not also target event:goal in property_filters; the call is rejected."
    • changedInput schema / properties / metrics / description
      Previous value: -"Metrics to return. Defaults vary by tool."New value: +"Metrics to return. Defaults vary by tool. Plausible rejects these combinations: bounce_rate or visit_duration with event:goal or event:props:<name> dimensions; pageviews, events, scroll_depth or time_on_page with visit:entry_page or visit:exit_page dimensions; views_per_visit with any non-time dimension or a page filter. For goal conversions use get_conversions."
    • changedInput schema / properties / page / description
      Previous value: -"Filter by page path. Exact match by default, use * as trailing wildcard (e.g. /blog*)"New value: +"Filter by page path. Exact match by default, use * as trailing wildcard (e.g. /blog*). Do not also target event:page in property_filters; the call is rejected."
    • changedInput schema / properties / period_a / pattern
      Previous value: -"^(\\d+h|\\d+d|\\d+mo|day|month|year|all|\\d{4}-\\d{2}-\\d{2},\\d{4}-\\d{2}-\\d{2})$"New value: +"^(\\d+h|\\d+d|\\d+mo|day|month|year|all|\\d{4}-\\d{2}-\\d{2},\\d{4}-\\d{2}-\\d{2}|\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:Z|[+-]\\d{2}:\\d{2}),\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:Z|[+-]\\d{2}:\\d{2}))$"
    • changedInput schema / properties / period_b / pattern
      Previous value: -"^(\\d+h|\\d+d|\\d+mo|day|month|year|all|\\d{4}-\\d{2}-\\d{2},\\d{4}-\\d{2}-\\d{2})$"New value: +"^(\\d+h|\\d+d|\\d+mo|day|month|year|all|\\d{4}-\\d{2}-\\d{2},\\d{4}-\\d{2}-\\d{2}|\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:Z|[+-]\\d{2}:\\d{2}),\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:Z|[+-]\\d{2}:\\d{2}))$"
  4. Changed8 schema fields changedv0.9.0
    • removedOutput schema / properties / deltas / additionalProperties / properties / absolute / anyOf
      Removed value: -[
-  {
-    "type": "number"
-  },
-  {
-    "type": "null"
-  }
-]
    • addedOutput schema / properties / deltas / additionalProperties / properties / absolute / type
      Added value: +[
+  "number",
+  "null"
+]
    • removedOutput schema / properties / deltas / additionalProperties / properties / percent / anyOf
      Removed value: -[
-  {
-    "type": "number"
-  },
-  {
-    "type": "null"
-  }
-]
    • addedOutput schema / properties / deltas / additionalProperties / properties / percent / type
      Added value: +[
+  "number",
+  "null"
+]
    • removedOutput schema / properties / period_a / properties / metrics / additionalProperties / anyOf
      Removed value: -[
-  {
-    "type": "number"
-  },
-  {
-    "type": "null"
-  }
-]
    • addedOutput schema / properties / period_a / properties / metrics / additionalProperties / type
      Added value: +[
+  "number",
+  "null"
+]
    • removedOutput schema / properties / period_b / properties / metrics / additionalProperties / anyOf
      Removed value: -[
-  {
-    "type": "number"
-  },
-  {
-    "type": "null"
-  }
-]
    • addedOutput schema / properties / period_b / properties / metrics / additionalProperties / type
      Added value: +[
+  "number",
+  "null"
+]
  5. Changed1 schema field changedv0.7.2
    • addedInput schema / properties / property_filters / items / properties / values / items / maxLength
      Added value: +1024
  6. Changed5 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 / 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: -[
-  "period_a",
-  "period_b"
-]New value: +[
+  "site_id",
+  "period_a",
+  "period_b"
+]
    • changedOutput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
  7. 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 cover the safety profile (readOnlyHint, idempotentHint, openWorldHint, no destructive hint). The description adds one genuinely useful behavioral fact beyond them: the arithmetic direction, deltas as period_b minus period_a and percent relative to period_a. It says nothing about return shape, missing-data handling, or whether the two ranges may overlap, though the presence of an output schema lowers the burden for the first.

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?

Front-loaded with purpose, then use case, then parameter semantics, in four short sentences with no filler. The final sentence largely restates what period_a and period_b already say in the schema, which is the only mild redundancy.

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 7-parameter read tool with full schema coverage, complete annotations, and an output schema, the description covers purpose, use case, and the one subtle semantic (delta direction). It does not mention how filters or metric defaults interact with the comparison, but the schema carries that load.

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 description coverage is 100%, so site_id, period_a, period_b, metrics, goal, page, and property_filters are all documented in the schema, including the same baseline/current orientation language the description repeats. The only added semantic is the delta formula, so this sits at the baseline rather than above it.

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 opens with a specific verb and resource: 'Compare metrics between two date ranges side by side', which clearly separates it from breakdown or timeseries style reads. It does not name a sibling directly, but the comparative framing is unambiguous enough that an agent can pick it without opening another schema.

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 gives a concrete use case ('before/after deploy analysis') and explicit orientation rules for the common current-vs-prior case, telling the agent which range goes in which slot. It stops short of naming an alternative tool or stating when not to use this one.

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

Deploy Server

Other Tools