Userflow

Analytics for an Adoption Agent flow.

get_adoption_agent_analytics

Ranked Adoption Agent conversation topics (requires topic modeling).

get_adoption_agent_top_topics

Aggregated Net Promoter Score over a date range: rolled-up totals plus daily `buckets`. The bucket size is fixed here, so week-by-week or month-by-month trends belong to get_survey_analytics, which takes `interval: week` or `month`.

get_nps_breakdown

Get a dashboard's layout and panel metadata.

get_dashboard_data

Full analytics for a single flow: session stats (views, completions, time series) plus a per-step breakdown with conversion rates for guides, a task breakdown for checklists, or views, reactions and comments for announcements. Per-task or per-step detail comes from here — get_flow_summary is the compact snapshot and carries no task breakdown. Across several flows, query_flow_metrics with include_steps compares step funnels in one call; for the worst drop-off alone, get_flow_summary is enough.

get_flow_analytics

Detailed info for one flow ID in a single environment (env_id): labels, alert policy, recent versions/publications, and publication status for that env only (flow_envs is filtered to the env you pass). For "live in all environments or only some?", call describe_session then call this tool once per env_id — a single production call cannot answer staging. Use list_flows to find the flow ID, and to answer catalog-wide questions (what is unpublished, draft, or labeled X) directly — those take one list call rather than a lookup per flow. The returned edited_at is the concurrency token update_flow requires as expected_edited_at — call this immediately before editing a flow.

get_flow_details

Performance snapshot for a single flow: session totals, completion rate, per-step funnel and worst drop-off, by flow_id or flow_name, with optional dates and user predicates. Comparing, ranking or totalling several flows is query_flow_metrics' job — it does the whole set in one call, where this tool would need one call per flow. A checklist's per-task breakdown lives in get_flow_analytics; catalog-wide questions (which flows are published, draft, labeled) in list_flows. Announcements report views, reactions and comments rather than completion metrics.

get_flow_summary

Analytics for one survey question within a flow, bucketed by `interval` — the path for week-by-week or month-by-month trends (set interval: week or month). A single rolled-up NPS score over a date range is get_nps_breakdown, whose interval is fixed at day.

get_survey_analytics

The raw event log for a user, company, or flow session, newest first. For "every recorded event" or individual event records, resolve the subject's UUID and come here; check_user_activity scans only a capped recent window, so it cannot stand in for the full log.

get_user_events

Reverse lookup: which segments include a given user or company — pass company_id for "which segments is Acme in?". Membership for one subject, where list_segments catalogues the segment definitions themselves.

get_user_segments

List conversations for an Adoption Agent flow.

list_adoption_agent_conversations

End users of the product in the current environment — the people using the app, not teammates or company members (Userflow exposes no teammate directory or teammate emails over MCP). "Which users…" asks belong here: filter with predicates, combined with AND — enterprise-plan users who signed in this week is a plan attribute plus a signed_in event or last_seen_at within_days. query_usage_metrics answers how many, not who, so it can't produce the list. Free-text and exact-id search are also available.

list_users

User, company, event, and company-membership attribute definitions. Attribute questions are workspace-specific, so read them from here rather than from memory. Pick the scope to match: "group_membership" for attributes of the user↔company relationship, "group" for company attributes, "event" for properties recorded on events (list_event_definitions returns event names instead). FQNs and scopes come back exactly as stored, company attributes under the `group/` prefix.

list_attribute_definitions

Lists existing usage and funnel charts (optional `types` filter). Only usage charts can be executed, via query_chart_data. If the chart the user named is a funnel, the honest answer is that funnel charts aren't queryable over MCP yet — there is no substitute path, so reaching for query_chart_data, query_flow_metrics, get_flow_summary, or a flow that happens to share the chart's name would report something other than what was asked.

list_charts

Companies in the current environment. When the ask names a plan or attribute, filter server-side with predicates — company FQNs carry the group/ prefix, so "companies on the enterprise plan" is group/plan eq enterprise — and with segment_id where relevant; filtering an unfiltered dump in prose gives the same answer only until the list outgrows one page. "The first N companies by name" is order_by on the name FQN (typically group/name) together with limit: N in the same call, for the same reason. "Companies that did event X" works either as an event predicate here or as query_usage_metrics with measurement: unique_companies.

list_companies

List analytics dashboards in the workspace.

list_dashboards

All tracked event definitions — the event names and their metadata. The properties recorded on events are a separate catalogue: list_attribute_definitions with scope: "event", which can be populated even when no event definitions exist yet.

list_event_definitions

List individual flow sessions with pagination.

list_flow_sessions

List who has interacted with / been tracked on a flow. Auto-routes by flow type: session-based flows (flow, checklist, launcher, …) return sessions; trackers return tracker users; announcements return announcement users. Supports pagination and date filtering — not the flow's targeting/audience *configuration*.

list_flow_subjects

List survey questions from a flow's published version.

list_flow_survey_questions

Lists flows with optional filters and metadata. Every call carries a types scope: `types` when the user named a kind, otherwise `list_all_flow_types: true` — choose it from the ask rather than checking back, and prefer the catalog-wide flag over a guessed subset, which would quietly hide flows. Filters compose, so keep label, state, edited_after and order_by alongside the types scope.

list_flows

Users with no recent activity, over a configurable inactivity threshold. A read-only lookup: Userflow exposes no email or messaging tool over MCP, so an ask like "email the inactive users" ends with the list plus a note that sending isn't available. Creating a segment wouldn't send anything either, so it isn't a substitute — offer it only if the user wants the audience saved.

list_inactive_users

List labels (id, name, color) — shared across flows, charts and dashboards, and the same labels used by the label filter in list_flows.

list_labels

Catalogue of audience segment definitions for the account (name, subject_type, archive state). Membership questions — "which segments is this user or company in?" — are answered by get_user_segments with their UUID.

list_segments

Raw survey answer rows for a flow, newest answer first — so "the last N answers" is this tool with limit: N. Date-bounded asks ("answers in the last N days", "this past week") should carry start_date in ISO 8601: a high limit with no window is a broad export and stops at the confirm_large_export gate, where a modest limit plus the window goes straight through. Summaries and trends are get_survey_analytics and get_nps_breakdown.

list_survey_responses

List visual themes available in the workspace.

list_themes

Execute a chart's configured metrics against the environment. Usage charts only — funnel charts are not yet queryable via MCP: if list_charts shows type funnel, refuse and stop (do not run query_flow_metrics with the chart name).

query_chart_data

Compares, ranks, and totals session metrics across flows in a single call: pass one or more flow names or UUIDs in `flows` and get views, completions and rates back, ranked by `sort_by`/`sort_dir` — "which flow performs worst", "rank these" and "the best of these" are all that pair, and the key defaults to views, so omitting it quietly answers a different question. This is the right tool whenever more than one flow is involved — repeated get_flow_summary calls answer the same question far more slowly. For "across all our flows", resolve the catalog with list_flows first and pass every name or id. A single flow is better served elsewhere: get_flow_summary for its snapshot or step funnel, get_flow_analytics for its week-by-week trend (or set include_time_series: true alongside `interval` here, since `interval` on its own returns totals). Requires a time window: last_n_days, start_date/end_date, or all_time: true. The audience filter is `predicates` — `subject_predicates` belongs to query_usage_metrics and would be dropped here, leaving the results unfiltered. Announcements report views, reactions and comments rather than completion metrics. Charts are not flows: a chart named by the user goes through query_chart_data (usage charts only).

query_flow_metrics

Event-log analytics for any tracked event (names from list_event_definitions; no attribute definitions needed). `measurement` is required — see that field for which one a question implies. For "break down signed_in by plan" pass group_by: ["plan"] (or ["group/plan"]) with a time window — group_by does the splitting, where a subject_predicate on plan would filter to a single one. A "which companies" question asks for identities, and measurement only ever returns a count: unique_companies tells you how many, group_by ["group/name"] names them, and list_companies with an event predicate lists them as rows. The audience filter here is `subject_predicates`; `predicates` is query_flow_metrics' name for it and would be dropped, leaving the results unfiltered. Match the FQN scope to the question: "enterprise-plan users" is the user's own attribute, subject_type user with fqn "plan" and value "enterprise" (not "enterprise-plan"), while "users whose company is on the enterprise plan" is fqn "group/plan" — both are valid here, they just answer different questions. Not for listing which users match filters (use list_users with predicates) or a named company's recent event rows (use check_user_activity with company_identifier + event_name). Not for flow performance — views/completions/funnels live in get_flow_summary, get_flow_analytics, and query_flow_metrics.

query_usage_metrics

Return the full content of a static MCP resource by URI or keyword (e.g. "predicate-dsl" for the predicate DSL reference).

read_resource

Return the full content of a Userflow knowledge base article by the `id` returned by search_knowledge_base. Use this instead of fetching the article url.

read_knowledge_base

The source for "how do I…?", install, snippet and product-help questions about using Userflow: search with the user's question as `q` and answer from the results, since setup steps change with the product and recollection goes stale. When the user asks for the top N articles, set limit to exactly that N ("top 3" → limit: 3). Searches Userflow's public help docs at help.userflow.com rather than this workspace's data, so no env_id. Each hit carries an `id` for read_knowledge_base, which returns the full article — more reliable than fetching the url.

search_knowledge_base

Publishes or unpublishes a flow in the authenticated environment. Consent-gated: call it without `confirm` first and the confirmation_required response returns the impact summary to show the user, then pass confirm: true once they approve. Unpublishing is not deletion, and archiving and deleting a flow aren't supported at all — those asks are better answered as unsupported, with unpublish offered in your reply for the user to choose, than started as a consent flow they didn't request.

set_flow_publication

Update metadata and unpublished draft settings/content for a flow, optionally including a Builder-like draft object, and return a Userflow Builder URL. Requires expected_edited_at (the draft's edited_at from get_flow_details) and rejects writes based on a stale draft with a stale_flow error. Every draft-content write also snapshots the previous draft as a new frozen version, recoverable from the Builder's version history.

update_flow