Skip to main content
Glama

Heatmap

get_heatmap
Read-onlyIdempotent

Where people click and how far they scroll on a page. The pages with heatmap data.

Input Schema

NameRequiredDescriptionDefault
toNoEnd date, inclusive (YYYY-MM-DD), for period custom
fromNoStart date (YYYY-MM-DD), for period custom
pathNoA page's path, e.g. /pricing
viewNoWhich part: default (Heatmap), pages (Heatmap pages)
deviceNoA device: Mobile, Desktop or Tablet
periodNoDate range in the website's timezone, as on the dashboard: today, 24h, 7d, 30d (default), 90d, 12m, mtd, lastmonth, ytd, all, custom…
websiteYesWebsite id or domain, e.g. example.com (see list_websites)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

C2.5/5.0
Behavior2/5

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

Annotations already declare readOnlyHint, idempotentHint, non-destructive and closed-world, so safety is covered. The description adds almost nothing beyond that: it never says whether a path is required for click data, that sites without heatmap tracking may return empty results, or what the payload looks like — only the oblique fragment 'The pages with heatmap data' gestures at data availability.

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

Conciseness3/5

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

It is short and front-loads the core concept, which is good. But the second sentence is a dangling noun phrase ('The pages with heatmap data') rather than a usable statement, so brevity comes at the cost of clarity rather than being earned conciseness.

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?

Seven parameters, a dual view mode, and date-range filtering with no output schema mean the description needed to do real work. As written it omits the interaction between 'view', 'path' and 'period', and says nothing about return shape or empty-data behavior, leaving significant gaps for an agent to discover by trial.

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% and every parameter carries an inline description (including the view enum and the period vocabulary), so the schema does the heavy lifting. The tool description adds no parameter meaning beyond that, which is the expected baseline-3 outcome when coverage is complete.

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

Purpose3/5

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

The fragments 'Where people click and how far they scroll on a page' convey the resource (click/scroll heatmap) and the second fragment hints at a page listing mode. However, the phrasing is disjointed and never states a specific verb or what the tool actually returns, and it does not differentiate from siblings like get_pages or get_recordings_summary, which also surface per-page engagement data.

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 prerequisites, and no mention of alternatives. An agent cannot tell from the description whether to reach for get_heatmap versus get_pages when it needs page-level engagement, nor when the 'pages' view mode is preferable.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources