rybbit-mcp

List Users

rybbit_list_users

Read-onlyIdempotent

List users for a site with session counts, first/last seen dates, and traits. Filter by analytics dimensions or search by username, email, or name.

Instructions

List users for a site. Returns user IDs, session counts, first/last seen dates, and user traits. Supports filtering by most analytics dimensions. Use 'search' param to find users by username/email/name (case-insensitive partial match). IMPORTANT: event_name filter is silently STRIPPED here — upstream backend returns HTTP 500. To rank users by a specific event, use rybbit_get_event_user_leaderboard instead. Call rybbit_describe_dimension to see capability per filter dimension.

Input Schema

TableJSON Schema

Name	Required	Description
`page`	No	Page number, 1-indexed (default: 1)
`limit`	No	Results per page (default: 20-50 depending on endpoint, max 200)
`search`	No	Search users by trait value (e.g. username, email). Uses case-insensitive partial matching (ILIKE).
`siteId`	Yes	Site ID (numeric ID or domain identifier)
`sortBy`	No	Sort field (default: 'last_seen'). 'duration' sorts by total time spent (aggregated from sessions, requires date range).
`endDate`	No	End date in ISO format (YYYY-MM-DD)
`filters`	No	Array of filters. Example: [{parameter:'browser',type:'equals',value:['Chrome']},{parameter:'country',type:'equals',value:['US','DE']}]
`timeZone`	No	IANA timezone (e.g., Europe/Prague). Default: UTC
`sortOrder`	No	Sort direction (default: 'desc')
`startDate`	No	Start date in ISO format (YYYY-MM-DD)
`searchField`	No	Which field to search in (default: 'username'). Only used when 'search' is provided.
`identifiedOnly`	No	Only return identified users (users with identified_user_id). Default: false.
`pastMinutesEnd`	No	Alternative to dates: minutes ago end (default 0 = now)
`pastMinutesStart`	No	Alternative to dates: minutes ago start (e.g., 60 = last hour)

Output Schema

TableJSON Schema

Name	Required	Description	Default
`data`	No	User rows

Schema Changelog

Changes observed during successful MCP inspections.

Changed2 schema fields changedv0.8.1Sep 28, 2026

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."

changedOutput schema / (root)

Previous value: -nullNew value: +{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "additionalProperties": false,
+  "properties": {
+    "data": {
+      "description": "User rows",
+      "items": {
+        "additionalProperties": {},
+        "type": "object"
+      },
+      "type": "array"
+    }
+  },
+  "type": "object"
+}

Changed1 schema field changedv0.4.3Apr 30, 2026

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."

First observedv0.5.2Apr 2, 2026

TDQS

A4.8/5.0

Behavior5/5

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

Annotations already declare readOnly/idempotent/no-destructive, but the description adds genuinely non-obvious behavior beyond them: the event_name filter is silently STRIPPED because the backend returns HTTP 500, plus a description of the return payload. That surfaces a hidden failure mode the agent would otherwise hit blind.

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 and returns, then the critical event_name gotcha and the routing pointer. It is dense with multiple directives but each sentence earns its place; only minor tightening would help.

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

Completeness5/5

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

For a 14-parameter, read-only list tool with an output schema present, the description covers what it returns, how to search, how to filter, and the one dangerous filter pitfall. Nothing essential for correct invocation is missing.

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 coverage is 100%, so the 3 baseline applies, but the description goes further by clarifying the search param uses case-insensitive partial matching, positioning searchField as its companion, and flagging the event_name filter behavior tied to a specific parameter.

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?

The description states a specific verb and resource ('List users for a site') and enumerates the returned fields (user IDs, session counts, first/last seen, traits), letting an agent distinguish it from siblings like rybbit_get_event_user_leaderboard and rybbit_list_sessions without opening a schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It gives explicit routing: use 'search' to find users by username/email/name, use rybbit_get_event_user_leaderboard when ranking by a specific event, and call rybbit_describe_dimension to learn filter capabilities. It also states the case that breaks (event_name filter) with the alternative to use instead.

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

Deploy Server