Skip to main content
Glama
arttus

umami-mcp-server

by arttus
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

Create a funnel visible in the Umami UI

umami_create_funnel

Persist a funnel with ordered page-path or event steps and a session window, making it visible under Behavior > Funnels for dashboard users.

Instructions

Create a persisted Funnel that appears under Behavior > Funnels in the Umami web UI, not just a computed result. Unlike umami_get_funnel (which computes step conversion on demand and shows nothing in the UI), this saves the funnel definition so it shows up for anyone browsing the dashboard.

Args:

  • website (string, optional): Website ID, name, or domain.

  • name (string, required): Display name for the funnel.

  • steps (array, required): 2-8 ordered steps, each { type: 'path' | 'event', value: string }.

  • window_minutes (number): Minutes a session has to complete all steps in order, default 60.

Returns: { "id": string, "name": string, "type": "funnel", "parameters": object }

Examples:

  • "/ -> /audit -> audit_submit funnel" -> steps=[{type:'path',value:'/'},{type:'path',value:'/audit'},{type:'event',value:'audit_submit'}]

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameYesDisplay name for the funnel.
stepsYesOrdered steps: page paths or event names.
websiteNoWebsite ID (UUID), name, or domain. Optional if UMAMI_DEFAULT_WEBSITE is set. Use umami_list_websites to discover values.
window_minutesNoSession completion window, in minutes.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already indicate this is not read-only, not idempotent, and not destructive. The description adds useful behavioral context beyond those hints: the funnel is persisted, appears for anyone browsing the dashboard, and is not merely a transient computed result. It also discloses the return shape, which helps set expectations for a create operation.

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?

The description is well structured and front-loaded, starting with the core persistence/UI distinction, then providing Args, Returns, and a concrete Example. Every section adds value, especially the return shape and example steps, without unnecessary filler.

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?

With no output schema, the description provides a return shape, which is essential for an agent to interpret results. It covers all four parameters, gives a realistic example, and explains the key difference from umami_get_funnel. The tool is complex enough that this level of detail makes it safely callable without external documentation.

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 the schema already documents all four parameters. The description restates parameter meaning without adding significant new semantics, though it does helpfully summarize constraints like '2-8 ordered steps' and 'default 60' in a single place. This is acceptable but not additive beyond the schema.

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 the tool creates a 'persisted Funnel' that appears under 'Behavior > Funnels in the Umami web UI', clearly distinguishing it from a computed result. It explicitly contrasts with umami_get_funnel, so an agent can differentiate this tool from its closest sibling without guessing.

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?

The description explicitly says 'Unlike umami_get_funnel (which computes step conversion on demand and shows nothing in the UI)', directly guiding the agent to choose this tool when persistence and dashboard visibility are needed. It also references when get_funnel would not suffice, giving clear selection criteria.

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