Skip to main content
Glama
umami-mcp

umami-mcp

by mikusnuz

get_session_data_properties

Retrieve session data property names and data types for an Umami website to identify available analytics fields for filtering or validation.

Instructions

Get session data property names and their data types for a website

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": {
      "websiteId": "<websiteId>",
      "startAt": "<startAt>",
      "endAt": "<endAt>"
    },
    "name": "get_session_data_properties"
  }
}

Input Schema

NameRequiredDescriptionDefault
endAtYesEnd timestamp in milliseconds
filtersNoAdditional current Umami filter fields
startAtYesStart timestamp in milliseconds
websiteIdYesWebsite UUID
propertyNameNoOptional property name

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv2.1.1
    • addedInput schema / properties / filters
      Added value: +{
      +  "additionalProperties": {
      +    "type": [
      +      "string",
      +      "number",
      +      "boolean"
      +    ]
      +  },
      +  "description": "Additional current Umami filter fields",
      +  "type": "object"
      +}
    • addedInput schema / properties / propertyName
      Added value: +{
      +  "description": "Optional property name",
      +  "type": "string"
      +}
  2. First observedv1.2.1

TDQS

C2.9/5.0
Behavior2/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 of behavioral disclosure. It implies a read operation and says what is returned (names and types), but says nothing about required permissions, result size/ordering, or whether a missing websiteId errors versus returning empty. For a query tool with zero annotation coverage this is a significant gap.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

A single tight sentence with the resource and scope front-loaded and zero filler. It is efficient, though its brevity is also the source of the coverage gaps noted elsewhere.

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

Completeness2/5

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

The tool takes five parameters including a nested free-form filters object, and has no output schema and no annotations. A one-sentence description that omits return shape, filter semantics, and the role of propertyName is not enough for an agent to call it confidently in the presence of near-identical siblings.

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 all five parameters (websiteId, startAt, endAt, filters, propertyName) are documented in the schema itself. The description adds no parameter detail at all, so baseline 3 applies; notably the optional propertyName semantics are not clarified beyond the schema.

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 and resource: returns session data property *names and their data types* for a website. This is clearly distinct from the value-returning sibling get_session_data_values, though the description never names it explicitly. An agent can grasp the intent without opening the schema, but sibling differentiation is left implicit.

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

Usage Guidelines2/5

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

No when-to-use, when-not-to-use, or alternative is given, despite a crowded sibling set (get_session_properties, get_session_data_values, get_session_stats). The typical use — discovering which property keys exist before querying values — must be inferred. No prerequisites or auth context are mentioned.

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