Skip to main content
Glama
nks-hub

rybbit-mcp

by nks-hub

Metric Breakdown

rybbit_get_metric
Read-onlyIdempotent

Get metric breakdown by dimension, such as top pages, browsers, countries, or traffic sources. Returns counts, percentages, bounce rate, and session duration from Rybbit Analytics.

Instructions

Get metric breakdown by dimension. Use parameter='pathname' for top pages, 'browser'/'operating_system'/'device_type' for tech stats, 'country'/'city' for geo, 'utm_source'/'utm_campaign' for marketing, 'referrer'/'channel' for traffic sources, 'entry_page'/'exit_page' for user flow. Returns sorted list with counts, percentages, bounce rate, and session duration.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pageNoPage number, 1-indexed (default: 1)
limitNoResults per page (default: 20-50 depending on endpoint, max 200)
siteIdYesSite ID (numeric ID or domain identifier)
endDateNoEnd date in ISO format (YYYY-MM-DD)
filtersNoArray of filters. Example: [{parameter:'browser',type:'equals',value:['Chrome']},{parameter:'country',type:'equals',value:['US','DE']}]
timeZoneNoIANA timezone (e.g., Europe/Prague). Default: UTC
parameterYesMetric dimension to break down by. device_model and app_version apply only to mobile-type sites (legacy: app) tracked via SDK.
startDateNoStart date in ISO format (YYYY-MM-DD)
pastMinutesEndNoAlternative to dates: minutes ago end (default 0 = now)
pastMinutesStartNoAlternative to dates: minutes ago start (e.g., 60 = last hour)

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
dataYesMetric breakdown rows
totalCountNoTotal rows across all pages

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changedv0.8.1
    • changedInput schema / properties / filters / items / properties / parameter / description
      Previous value: -"Filter dimension. One of: browser, browser_version, operating_system, operating_system_version, language, country, region, city, device_type, device_model, app_version, dimensions, referrer, hostname, pathname, page_title, querystring, event_name, channel, utm_source, utm_medium, utm_campaign, utm_term, utm_content, entry_page, exit_page, user_id, lat, lon, timezone, vpn, crawler, datacenter, company, company_type, company_domain, asn_org, asn_type, asn_domain, tag. Custom URL parameters use the prefix 'url_param:NAME' (e.g., 'url_param:campaign_id'). Note: user_id filter checks BOTH the device hash (user_id) and app-provided ID (identified_user_id). device_model and app_version are populated only for app-type sites tracked via SDK."New value: +"Filter dimension. One of: browser, browser_version, operating_system, operating_system_version, language, country, region, city, device_type, device_model, app_version, dimensions, referrer, hostname, pathname, page_title, querystring, event_name, channel, utm_source, utm_medium, utm_campaign, utm_term, utm_content, entry_page, exit_page, user_id, lat, lon, timezone, tag. Custom URL parameters use the prefix 'url_param:NAME' (e.g., 'url_param:campaign_id'). Note: user_id filter checks BOTH the device hash (user_id) and app-provided ID (identified_user_id). device_model and app_version are populated only for mobile-type sites (legacy: app) tracked via SDK."
    • changedInput schema / properties / parameter / description
      Previous value: -"Metric dimension to break down by. device_model and app_version apply only to app-type sites tracked via SDK."New value: +"Metric dimension to break down by. device_model and app_version apply only to mobile-type sites (legacy: app) tracked via SDK."
    • changedInput schema / properties / parameter / enum
      Previous value: -[
      -  "browser",
      -  "browser_version",
      -  "operating_system",
      -  "operating_system_version",
      -  "language",
      -  "country",
      -  "region",
      -  "city",
      -  "device_type",
      -  "device_model",
      -  "app_version",
      -  "dimensions",
      -  "referrer",
      -  "hostname",
      -  "pathname",
      -  "page_title",
      -  "querystring",
      -  "event_name",
      -  "channel",
      -  "utm_source",
      -  "utm_medium",
      -  "utm_campaign",
      -  "utm_term",
      -  "utm_content",
      -  "entry_page",
      -  "exit_page",
      -  "timezone",
      -  "company",
      -  "company_type",
      -  "asn_org",
      -  "asn_type"
      -]New value: +[
      +  "browser",
      +  "browser_version",
      +  "operating_system",
      +  "operating_system_version",
      +  "language",
      +  "country",
      +  "region",
      +  "city",
      +  "device_type",
      +  "device_model",
      +  "app_version",
      +  "dimensions",
      +  "referrer",
      +  "hostname",
      +  "pathname",
      +  "page_title",
      +  "querystring",
      +  "event_name",
      +  "channel",
      +  "utm_source",
      +  "utm_medium",
      +  "utm_campaign",
      +  "utm_term",
      +  "utm_content",
      +  "entry_page",
      +  "exit_page",
      +  "timezone"
      +]
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "$schema": "http://json-schema.org/draft-07/schema#",
      +  "additionalProperties": false,
      +  "properties": {
      +    "data": {
      +      "description": "Metric breakdown rows",
      +      "items": {
      +        "additionalProperties": true,
      +        "properties": {
      +          "bounceRate": {
      +            "type": "number"
      +          },
      +          "count": {
      +            "type": "number"
      +          },
      +          "percentage": {
      +            "type": "number"
      +          },
      +          "timeOnPage": {
      +            "type": "number"
      +          },
      +          "value": {
      +            "type": "string"
      +          }
      +        },
      +        "type": "object"
      +      },
      +      "type": "array"
      +    },
      +    "totalCount": {
      +      "description": "Total rows across all pages",
      +      "type": "number"
      +    }
      +  },
      +  "required": [
      +    "data"
      +  ],
      +  "type": "object"
      +}
  2. Changed3 schema fields changedv0.4.3
    • changedInput schema / properties / filters / items / properties / parameter / description
      Previous value: -"Filter dimension: browser, operating_system, language, country, region, city, device_type, referrer, hostname, pathname, page_title, querystring, event_name, channel, utm_source, utm_medium, utm_campaign, utm_term, utm_content, entry_page, exit_page, user_id. Note: user_id filter checks BOTH the device hash (user_id) and app-provided ID (identified_user_id)."New value: +"Filter dimension. One of: browser, browser_version, operating_system, operating_system_version, language, country, region, city, device_type, device_model, app_version, dimensions, referrer, hostname, pathname, page_title, querystring, event_name, channel, utm_source, utm_medium, utm_campaign, utm_term, utm_content, entry_page, exit_page, user_id, lat, lon, timezone, vpn, crawler, datacenter, company, company_type, company_domain, asn_org, asn_type, asn_domain, tag. Custom URL parameters use the prefix 'url_param:NAME' (e.g., 'url_param:campaign_id'). Note: user_id filter checks BOTH the device hash (user_id) and app-provided ID (identified_user_id). device_model and app_version are populated only for app-type sites tracked via SDK."
    • changedInput schema / properties / parameter / description
      Previous value: -"Metric dimension to break down by"New value: +"Metric dimension to break down by. device_model and app_version apply only to app-type sites tracked via SDK."
    • changedInput schema / properties / parameter / enum
      Previous value: -[
      -  "browser",
      -  "operating_system",
      -  "language",
      -  "country",
      -  "region",
      -  "city",
      -  "device_type",
      -  "referrer",
      -  "hostname",
      -  "pathname",
      -  "page_title",
      -  "querystring",
      -  "event_name",
      -  "channel",
      -  "utm_source",
      -  "utm_medium",
      -  "utm_campaign",
      -  "utm_term",
      -  "utm_content",
      -  "entry_page",
      -  "exit_page"
      -]New value: +[
      +  "browser",
      +  "browser_version",
      +  "operating_system",
      +  "operating_system_version",
      +  "language",
      +  "country",
      +  "region",
      +  "city",
      +  "device_type",
      +  "device_model",
      +  "app_version",
      +  "dimensions",
      +  "referrer",
      +  "hostname",
      +  "pathname",
      +  "page_title",
      +  "querystring",
      +  "event_name",
      +  "channel",
      +  "utm_source",
      +  "utm_medium",
      +  "utm_campaign",
      +  "utm_term",
      +  "utm_content",
      +  "entry_page",
      +  "exit_page",
      +  "timezone",
      +  "company",
      +  "company_type",
      +  "asn_org",
      +  "asn_type"
      +]
  3. First observedv0.5.2

TDQS

A4.2/5.0
Behavior3/5

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

Annotations already declare readOnly, idempotent, non-destructive, closed-world behavior, so the safety profile is covered. The description adds the return shape (sorted list with counts, percentages, bounce rate, session duration), but that largely duplicates the existing output schema and omits pagination/limit behavior. Adequate, not rich.

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, front-loaded with the core action, followed by a dense but purposeful dimension map. No filler or restatement of the tool name; every clause carries routing information.

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?

With an output schema, rich annotations, and full schema coverage, the description needs only to establish purpose and dimension routing, which it does. Minor gap: no mention of pagination defaults or how filters interact with the breakdown, though those are schema-documented.

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

Parameters4/5

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

Schema description coverage is 100%, so the schema already documents every parameter and the baseline would be 3. The description earns a notch above by adding semantic grouping of the `parameter` enum values into analytic categories, which gives the agent practical meaning beyond the raw enum list.

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?

States a specific verb+resource ('Get metric breakdown by dimension') and then enumerates the concrete dimension values grouped by analytic intent (pages, tech, geo, marketing, traffic, flow). An agent can tell this apart from siblings like rybbit_get_event_aggregate or rybbit_describe_dimension without opening the 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?

Gives explicit routing logic: which parameter value to use for each analysis goal ('pathname' for top pages, 'country'/'city' for geo, etc.). This is genuine when-to-use guidance. It does not, however, state when NOT to use this tool or name a preferred alternative for overlapping cases (e.g., describe_dimension or event aggregates).

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