Skip to main content
Glama
arttus

umami-mcp-server

by arttus
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

Create a goal visible in the Umami UI

umami_create_goal

Create a saved goal in Umami so it appears in the Behavior > Goals dashboard, enabling persistent conversion tracking for page paths or custom events.

Instructions

Create a persisted Goal that appears under Behavior > Goals in the Umami web UI, not just a computed result. Unlike umami_get_goal (which computes a conversion rate on demand and shows nothing in the UI), this saves the goal 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 goal.

  • match_type ('path' | 'event', required): Whether the goal is reaching a page or firing a custom event.

  • value (string, required): The page path (e.g. '/thank-you') or event name (e.g. 'signup') to match.

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

Error handling:

  • match_type='event' accepts any event name, even one that has never fired yet; the goal will just show 0 conversions until it does.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameYesDisplay name for the goal.
valueYesPage path (e.g. '/thank-you') or event name (e.g. 'signup').
websiteNoWebsite ID (UUID), name, or domain. Optional if UMAMI_DEFAULT_WEBSITE is set. Use umami_list_websites to discover values.
match_typeYesWhether the goal matches a page path or a custom event.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

A4.9/5.0
Behavior5/5

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

The annotation readOnlyHint=false indicates a write operation, and the description enriches this by explaining the goal is persisted, appears in the dashboard UI, and remains until changed. It also discloses return shape and an important edge case: match_type='event' accepts event names that have never fired and will show 0 conversions until they do. This goes well beyond what annotations alone provide.

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 front-loaded with the core purpose and sibling distinction, then uses clearly labeled Args, Returns, and Error handling sections. Every element earns its place, and the prose is tight 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?

Given four parameters, no output schema, and minimal annotations, the description covers creation semantics, UI visibility, parameter behavior, return format, and an error edge case. An agent has enough information to invoke the tool correctly and to interpret its response without needing additional schema context.

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?

Input schema coverage is 100%, so the schema already documents all four parameters. The description largely repeats these definitions but adds one meaningful semantic insight: match_type='event' accepts any event name, even one that has never fired yet, which clarifies the value and match_type interaction 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 a specific verb and resource: 'Create a persisted Goal that appears under Behavior > Goals in the Umami web UI.' It clearly contrasts with umami_get_goal, which 'computes a conversion rate on demand and shows nothing in the UI', so an agent can immediately distinguish this tool from related siblings.

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 names the alternative umami_get_goal and explains the key difference: create_goal persists a UI-visible goal, while get_goal only computes on-demand. This tells an agent when to select this tool over the closest sibling, which satisfies the explicit when/when-not guidance criterion.

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