Skip to main content
Glama

Heatmap

generate_heatmap_chart
Read-only

Draw a heatmap: a grid of cells coloured by value, with x and y categories (e.g. weekday × hour, product × region). Returns an image link.

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": {
      "data": "<data>"
    },
    "name": "generate_heatmap_chart"
  }
}

Input Schema

NameRequiredDescriptionDefault
dataYes
themeNo
titleNoTitle shown above the chart.
widthNoImage width in pixels (default 720).
heightNoImage height in pixels (default 480).
brandThemeNoName of a brand theme saved on the user's account (their colours and footer), only when the user asks for their theme. Or "colorblind" for colours that people with colour-vision deficiency can tell apart (anyone can use it).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.5/5.0
Behavior3/5

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

With readOnlyHint=true already declaring the safety profile, the description's main addition is the return contract ('Returns an image link'), which is valuable since there is no output schema. It says nothing about the 5,000-item data cap, behavior when x/y categories are too numerous to render legibly, or what the image link's lifetime is.

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?

Two tight sentences: the visual definition comes first, the return format last. Every clause carries information and there is no filler or restatement of the title.

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

Completeness3/5

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

For a six-parameter chart generator with an annotations-declared read-only profile, the definition covers the essential what and the output shape adequately. It falls short on sibling disambiguation against generate_calendar_heatmap and on any mention of the data-volume limits or category-count caveats that would matter when calling it.

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 coverage is 67%, with title, width, height and brandTheme already documented in the schema, so the baseline of 3 applies. The description adds conceptual meaning by framing x and y as categories rather than coordinates, but contributes nothing about theme, sizing, or when to use brandTheme versus the built-in colorblind option.

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?

The description gives a specific verb and resource ('Draw a heatmap') and then defines the visual form ('a grid of cells coloured by value, with x and y categories') with concrete examples. It clearly separates this from most chart siblings, but it never distinguishes it from the close sibling generate_calendar_heatmap, so an agent can't rule that one out from this text alone.

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

Usage Guidelines3/5

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

Usage is implied rather than stated: the examples (product × region) hint at categorical cross-tabulation, but there is no explicit when-to-use, when-not-to-use, or alternative routing. Notably, 'weekday × hour' is offered as an example even though a dedicated calendar heatmap sibling exists, without guidance on which to pick.

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