Skip to main content
Glama

create_heatmap_query

Save a new heatmap query as a chart and optionally add it to a dashboard. Pass the exact spec you already ran successfully with run_heatmap_query — run it first so you know it works. Adding to a dashboard also requires permission to edit dashboards. The query is saved when this runs; explain it in reason. Load the manage-dashboards, heatmap-queries skills (load_skill("manage-dashboards"), load_skill("heatmap-queries")) first.

Input Schema

NameRequiredDescriptionDefault
nameYesShort chart title, e.g. 'Daily active players'. No time range.
specYesThe heatmap definition — exactly the spec you ran with run_heatmap_query.
reasonYesWhy you are making this change, in one sentence the user will read on the approval card.
projectIdYesThe project (application) id to scope this call to. Use list_projects to discover valid ids.
dashboardIdNoDashboard to add the new query to (appended at the end). Omit to save it unattached.
descriptionNoPlain-language description of what the chart measures: the events, the aggregation, and any filter, cohort, or breakdown that changes its meaning, in one or two sentences. No time range. Always write one, even when the user did not ask for it.
environmentYesThe environment name to scope this call to (e.g. 'production'). Use list_projects to discover the names available to this token.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already declare a non-readonly, non-idempotent, non-destructive write, so the description adds genuinely new context: dashboard attachment requires edit-dashboard permission, the query is persisted on invocation, and reason surfaces on an approval card. It does not describe the returned identifier or confirmation, but the added operational and authorization context is substantial.

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?

Front-loads the core action and dashboard attachment, then moves to prerequisites and permissions in decreasing order of importance. The trailing skill-loading sentence is useful but slightly cluttered by the repeated inline function syntax.

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 7-parameter tool with a deeply nested heatmap spec, the description covers the workflow, the permission requirement, and the persistence side effect well. With no output schema, it leaves unstated what comes back (chart or query id) and how to later modify the saved chart via update_heatmap_query, which is the remaining gap.

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 the schema already documents spec, dashboardId, reason, name, projectId, and environment thoroughly. The description reinforces that spec must be the exact previously-executed payload and that reason must explain the change, but those points largely restate the schema's own descriptions, so the baseline of 3 applies.

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?

States a specific verb and resource — save a new heatmap query as a chart, optionally attaching it to a dashboard — and implicitly contrasts with run_heatmap_query (execute) versus update_heatmap_query (modify). An agent can distinguish this from the other create_*_query siblings because it names the heatmap resource explicitly.

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?

Gives a concrete precondition for invocation: run run_heatmap_query first and pass that exact spec, plus load the manage-dashboards and heatmap-queries skills beforehand. It lacks an explicit when-not statement (e.g. 'use update_heatmap_query to modify an existing saved heatmap query'), which is the only gap.

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