Skip to main content
Glama
umami-mcp

umami-mcp

by mikusnuz

get_event_data_fields

Retrieve event property keys and their data types for a website within a time range, optionally filtered by event name, to inspect available event data fields.

Instructions

Get event data fields (property keys 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_event_data_fields"
  }
}

Input Schema

NameRequiredDescriptionDefault
endAtYesEnd timestamp in milliseconds
filtersNoAdditional current Umami filter fields
startAtYesStart timestamp in milliseconds
eventNameNoFilter by event name
websiteIdYesWebsite UUID

Schema Changelog

Changes observed during successful MCP inspections.

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

TDQS

B3.4/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 behavioral burden. It does disclose the return content (property keys and their data types), which is the most useful behavioral fact for a discovery call, but it says nothing about permissions, read-only nature, pagination, or scope of the time window.

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?

A single front-loaded sentence with zero filler; the parenthetical pays for itself by clarifying the return value. Nothing is wasted or buried.

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 moderate-complexity read tool with a fully documented schema and no output schema, the description covers purpose and return content adequately. The only meaningful gap is the absence of routing guidance versus sibling event-data tools.

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, eventName, filters) are already documented in the schema. The description adds no syntax, format, or semantics beyond what the schema provides, so the baseline 3 applies.

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?

Specific verb+resource: 'Get event data fields (property keys and their data types) for a website.' The parenthetical clarifies the return shape, which helps distinguish it from sibling read tools like get_event_data_values or get_event_data_properties. However, it never explicitly states how it differs from those near-identical siblings, so it stops short of a 5.

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?

There is no when-to-use guidance, no exclusions, and no mention of the many sibling tools (get_event_data_properties, get_event_data_values, get_event_data_stats) that an agent must choose between. Usage must be entirely inferred from the name.

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