Skip to main content
Glama
umami-mcp

umami-mcp

by mikusnuz

get_share

Resolve a public Umami share by slug without authentication to retrieve shared analytics data.

Instructions

Resolve a public Umami share by its slug without authentication

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "slug": "<slug>"
    },
    "name": "get_share"
  }
}

Input Schema

NameRequiredDescriptionDefault
slugYesPublic share slug

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changedv2.1.1
    • removedInput schema / properties / shareId
      Removed value: -{
      -  "description": "The share ID of a publicly shared website",
      -  "type": "string"
      -}
    • addedInput schema / properties / slug
      Added value: +{
      +  "description": "Public share slug",
      +  "type": "string"
      +}
    • changedInput schema / required
      Previous value: -[
      -  "shareId"
      -]New value: +[
      +  "slug"
      +]
  2. First observedv1.2.1

TDQS

A3.6/5.0
Behavior3/5

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

No annotations are provided, so the description carries the full burden; it does add one genuinely valuable trait — no authentication required, implying anonymous/public access. It does not disclose what a failed resolution returns (error vs empty), whether the share is read-only, or what data the resolved share exposes.

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?

One sentence, front-loaded with the verb and resource, with the access-model qualifier appended rather than buried. Nothing is wasted and nothing needs trimming.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a one-parameter read tool with no output schema, the essentials — what it resolves and that it needs no auth — are covered. The remaining gap is error behavior for a bad or expired slug, which is a modest omission rather than a blocking one.

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% on the single 'slug' parameter with a description ('Public share slug'), so the schema already does the work. The description only reaffirms that resolution is keyed on the slug, adding no format, example, or constraint detail.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb (resolve), a specific resource (public Umami share), and the lookup key (slug), so the operation is unambiguous. It implicitly separates from get_share_by_id via 'by its slug' and 'public', but never names that sibling explicitly.

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

Usage Guidelines3/5

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

'Public' and 'without authentication' imply the usage context (unauthenticated share links), which is useful signal. However, it never states when to prefer this over get_share_by_id or list_entity_shares, nor any precondition or failure case for an invalid slug.

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