Skip to main content
Glama

update_heatmap_query

DestructiveIdempotent

Replace the definition of a saved heatmap query (and optionally rename it). Read it with get_query first, change only what the user asked for, and pass the complete spec back without its queryType — it replaces the saved definition on every dashboard that shows the query. Run the new spec with run_heatmap_query first so you know it works. 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
nameNo
specYesThe complete new heatmap definition. Replaces the saved one entirely — start from get_query's spec (without its queryType) and change only what the user asked for.
reasonYesWhy you are making this change, in one sentence the user will read on the approval card.
queryIdYesThe saved heatmap query to change.
projectIdYesThe project (application) id to scope this call to. Use list_projects to discover valid ids.
descriptionNoNew description. Pass one when the new spec makes the saved description wrong, or when the query has none. Omit to keep the current one.
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.7/5.0
Behavior5/5

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

Annotations declare destructiveHint=true, and the description earns that by specifying the blast radius — the saved definition is replaced wholesale on every dashboard showing the query, so partial specs are dangerous. It also notes the change is saved immediately when the tool runs and that reason appears on the approval card, which is context the annotations do not carry.

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-loaded with the core action, then the workflow rules follow in order. Dense but nearly every clause is actionable; the explicit load_skill call syntax is mildly verbose but needed for the agent to follow it correctly.

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 destructive, deeply nested mutation with no output schema, the definition covers the read-modify-write workflow, the removal of queryType, validation via run_heatmap_query, and the replacement scope. It stops short of describing what the call returns or how to confirm the update landed.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

With 86% schema coverage the schema already documents most fields, but the description adds operational meaning: spec must be the complete definition with queryType stripped, and reason must be one sentence written for the approval card. It does not add much beyond the schema for queryId, projectId, environment, or name.

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?

"Replace the definition of a saved heatmap query (and optionally rename it)" gives a specific verb and resource, and it is immediately distinguishable from create_heatmap_query and run_heatmap_query, which are named later in the text as workflow steps.

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

Usage Guidelines5/5

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

The description prescribes the exact sequence: read with get_query, change only what the user asked for, dry-run with run_heatmap_query, then call this tool; it also directs the agent to load_skill("manage-dashboards") and load_skill("heatmap-queries") first. When-to-use and the alternatives are both explicit.

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