Skip to main content
Glama
arttus

umami-mcp-server

by arttus
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

List all Umami users

umami_list_users
Read-onlyIdempotent

List all user accounts on a self-hosted Umami instance, including usernames, roles, and creation dates. Requires admin access and is not available on Umami Cloud. Output as markdown or JSON.

Instructions

List every login account on this self-hosted Umami instance.

Admin access required. Not available on Umami Cloud.

Args:

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

Returns: JSON shape: { "count": number, "users": [ { "id": string, "username": string, "role": string, "created_at": string } ] }

Examples:

  • "Who has a login to our Umami?" -> no arguments

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
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
Behavior5/5

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

Annotations already mark the operation as read-only, idempotent, and non-destructive. The description adds valuable behavioral detail beyond that: admin privileges are required, Umami Cloud is excluded, and the exact JSON return shape is specified. This is especially important because there is no output schema.

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 well-structured, leading with the core purpose and then using short Args, Returns, and Examples sections. Every sentence contributes useful information, and the example clarifies that the tool can be called with no arguments.

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 simple list operation with one optional parameter, the description covers everything an agent needs: scope, access requirements, environment limitation, return shape, and a usage example. The lack of an output schema is compensated by the explicit JSON return contract.

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 coverage is 100%, and the schema already documents response_format with its enum, default, and meaning. The description's Args section largely restates this and the example only confirms the default behavior, adding no meaningful new parameter semantics.

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 opens with a specific verb and resource: 'List every login account on this self-hosted Umami instance.' It clearly distinguishes the tool from singular user operations like umami_get_user and from other list_* siblings by naming the exact resource being listed.

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

Usage Guidelines4/5

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

The description gives concrete usage context: admin access is required, and the tool is explicitly not available on Umami Cloud. It does not explicitly name alternative tools for related lookups, such as umami_get_user for a single account, so it stops short of a full 5.

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