Skip to main content
Glama
arttus

umami-mcp-server

by arttus
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

List saved goals, funnels, journeys, or retention reports

umami_list_saved_reports
Read-onlyIdempotent

List saved reports for a chosen type (goal, funnel, journey, retention) on a website. Retrieve report IDs, names, and parameters to review or manage saved analytics views.

Instructions

List the saved reports of one type for a website, as they appear in the Umami UI sidebar (Goals, Funnels, Journeys, Retention). For Segments or Cohorts, use umami_list_segments_cohorts instead — they live on a different endpoint.

Args:

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

  • type (string, required): One of 'goal', 'funnel', 'journey', 'retention'.

  • response_format ('markdown' | 'json'): Output format (default: 'markdown').

Returns: JSON shape: { "reports": [ { "id": string, "name": string, "type": string, "parameters": object, "created_at": string } ] }

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
typeYesReport type, matching the sidebar section it appears under in the Umami UI. For segments or cohorts, use umami_list_segments_cohorts instead.
websiteNoWebsite ID (UUID), name, or domain. Optional if UMAMI_DEFAULT_WEBSITE is set. Use umami_list_websites to discover values.
response_formatNoOutput format: 'markdown' for a readable summary, 'json' for raw structured data.markdown

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 convey read-only, idempotent, non-destructive behavior, so the description does not need to repeat safety traits. It adds useful context by specifying the returned JSON shape and by clarifying the UI-sidebar semantics. It does not mention pagination or list limits, but this is minor for a simple read-only listing tool.

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 compact and front-loaded with the core purpose, then gives the one important alternative, followed by concise arg and return summaries. Every section earns its place 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 the tool's low complexity, no output schema, and rich annotations, the description provides everything an agent needs: what it lists, how to scope it, which sibling to use instead, the argument semantics, and the exact return shape. No significant information is missing.

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 every parameter well. The description's Args section largely restates what the schema says, adding only marginal convenience; it introduces no substantial new meaning 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 clear action ('List the saved reports of one type for a website') and identifies the resource precisely as saved reports corresponding to the Umami UI sidebar sections. It also distinguishes itself from umami_list_segments_cohorts, making the tool's scope immediately clear relative to 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 says to use umami_list_segments_cohorts instead for Segments or Cohorts, and explains they live on a different endpoint. It also scopes the tool to one report type per call, which helps an agent decide how to invoke it correctly.

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