Skip to main content
Glama

Minds: Synthetic Market Research

Export Website Heatmap

export_heatmap

Exports a completed website heatmap from a Study result, identified by the message ID reported with the completed result. Returns the same ZIP archive as the web app, including its unified-renderer PDF report, Markdown, images, and metadata.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
forceNoRegenerate the ZIP archive instead of returning the cached artifact.
studyNoWhich Study the heatmap belongs to.
messageIdYesID of the completed Study result containing the website heatmap. Completed Study results report this identifier when the answer carries a heatmap.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
formatNoExport format.
studyIdNoStudy that ran the heatmap.
studyUrlNoMinds workspace link for the Study.
messageIdNoHeatmap result exported.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / study / properties / name / description
      Previous value: -"Study name (fuzzy matched among the newest 1,000 visible Studies; use studyId for older records)."New value: +"Study name (exact or partial, case-insensitive; fuzzy fallback for typos)."
  2. Changed6 schema fields changed
    • removedOutput schema / properties / messageId / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / messageId / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • removedOutput schema / properties / studyId / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / studyId / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • removedOutput schema / properties / studyUrl / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / studyUrl / type
      Added value: +[
      +  "string",
      +  "null"
      +]
  3. Changed5 schema fields changed
    • removedInput schema / properties / panelId
      Removed value: -{
      -  "description": "Study ID (UUID; legacy wire field name: panelId)",
      -  "type": "string"
      -}
    • removedInput schema / properties / panelName
      Removed value: -{
      -  "description": "Study name (fuzzy matched; legacy wire field name: panelName)",
      -  "type": "string"
      -}
    • addedInput schema / properties / study
      Added value: +{
      +  "description": "Which Study the heatmap belongs to.",
      +  "properties": {
      +    "id": {
      +      "description": "Study ID (UUID).",
      +      "type": "string"
      +    },
      +    "name": {
      +      "description": "Study name (fuzzy matched among the newest 1,000 visible Studies; use studyId for older records).",
      +      "type": "string"
      +    }
      +  },
      +  "type": "object"
      +}
    • removedInput schema / properties / studyId
      Removed value: -{
      -  "description": "Study ID (UUID).",
      -  "type": "string"
      -}
    • removedInput schema / properties / studyName
      Removed value: -{
      -  "description": "Study name (fuzzy matched among the newest 1,000 visible Studies; use studyId for older records).",
      -  "type": "string"
      -}
  4. Changed1 schema field changed
    • changedInput schema / properties / studyName / description
      Previous value: -"Study name (fuzzy matched)."New value: +"Study name (fuzzy matched among the newest 1,000 visible Studies; use studyId for older records)."
  5. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "$schema": "http://json-schema.org/draft-07/schema#",
      +  "additionalProperties": {},
      +  "properties": {
      +    "format": {
      +      "description": "Export format."
      +    },
      +    "messageId": {
      +      "anyOf": [
      +        {
      +          "type": "string"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "description": "Heatmap result exported."
      +    },
      +    "studyId": {
      +      "anyOf": [
      +        {
      +          "type": "string"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "description": "Study that ran the heatmap."
      +    },
      +    "studyUrl": {
      +      "anyOf": [
      +        {
      +          "type": "string"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "description": "Minds workspace link for the Study."
      +    }
      +  },
      +  "type": "object"
      +}
  6. Changed5 schema fields changed
    • changedInput schema / properties / messageId / description
      Previous value: -"ID of the completed panel message containing the website heatmap. Completed panel results report this identifier when the answer carries a heatmap."New value: +"ID of the completed Study result containing the website heatmap. Completed Study results report this identifier when the answer carries a heatmap."
    • changedInput schema / properties / panelId / description
      Previous value: -"Panel ID (UUID)"New value: +"Study ID (UUID; legacy wire field name: panelId)"
    • changedInput schema / properties / panelName / description
      Previous value: -"Panel name (fuzzy matched)"New value: +"Study name (fuzzy matched; legacy wire field name: panelName)"
    • addedInput schema / properties / studyId
      Added value: +{
      +  "description": "Study ID (UUID).",
      +  "type": "string"
      +}
    • addedInput schema / properties / studyName
      Added value: +{
      +  "description": "Study name (fuzzy matched).",
      +  "type": "string"
      +}
  7. Changed1 schema field changed
    • removedInput schema / additionalProperties
      Removed value: -false
  8. Changed1 schema field changed
    • changedInput schema / properties / messageId / description
      Previous value: -"ID of the completed panel message containing the website heatmap"New value: +"ID of the completed panel message containing the website heatmap. Completed panel results report this identifier when the answer carries a heatmap."
  9. Added

TDQS

A4/5.0
Behavior4/5

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

Annotations already declare the safety profile (readOnlyHint=false, idempotentHint=false, destructiveHint=false). The description goes beyond them by specifying the return artifact in detail: a unified-renderer PDF report plus Markdown, images, and metadata, matching the web app's ZIP. It does not restate the caching/regeneration behavior covered by the force parameter.

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 sentences with zero filler; the action and identifier requirement come first, followed by the return contents. Nothing is redundant.

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?

With an output schema present, return explanation is optional, yet the description nonetheless characterizes the archive contents. Preconditions and identification are covered; only explicit routing among sibling export tools is missing.

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 messageId, study, and force. The description only reinforces that messageId comes from the completed result, adding minimal meaning beyond the schema. Baseline 3 is appropriate.

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 (Exports) and resource (website heatmap from a Study result), and the required identifier (messageId). An agent can distinguish it from export_study, export_mind, and export_audience, which target different artifacts.

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?

It implies the correct precondition (a completed Study result carrying a heatmap, whose message ID is reported on completion), which routes the agent after run_study_heatmap finishes. However, it gives no explicit when-not guidance or named alternatives for overlapping export tools.

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.