Skip to main content
Glama

Minds: Synthetic Market Research

by ai.getminds
OverviewDiscussionsAdmin

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. 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"
-}
  2. 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)."
  3. 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"
+}
  4. 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"
+}
  5. Changed1 schema field changed
    • removedInput schema / additionalProperties
      Removed value: -false
  6. 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."
  7. Added

TDQS

A4/5.0
Behavior3/5

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

Annotations provide readOnlyHint=false, destructiveHint=false, but no explicit hints on safety. The description adds that it returns a ZIP archive, and mentions the force parameter regenerates the archive instead of returning cached. However, it doesn't disclose potential side effects like generating a large file or requiring specific permissions. The description adds some context but not extensive.

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?

The description is concise, two sentences, front-loaded with the main action and key identifier, then details the contents of the ZIP. No waste.

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?

Given the tool has an output schema (ZIP contents described), the description doesn't need to explain return values. It does mention the force parameter indirectly by saying 'same ZIP archive as the web app'. The main gap is lack of explicit when-to-use guidance, but overall it's complete for correct invocation.

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 covers 100% of parameters with descriptions, so baseline is 3. The description adds no extra meaning beyond the schema, but the schema itself is descriptive (e.g., messageId is 'ID of the completed Study result...'). Thus the description doesn't need to compensate.

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?

The description clearly states the tool exports a completed website heatmap from a Study result, identified by messageId. It specifies the exact resource (completed heatmap), the action (export), and the key identifier (messageId), which distinguishes it from siblings like export_study or run_study_heatmap.

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?

The description indicates when to use this tool: when a Study result is completed and reports a message ID. It does not explicitly mention when not to use it or name alternatives, but the context of exporting a heatmap is clear. Since it's the only export-specific heatmap tool among siblings, this is sufficient.

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

All Minds: Synthetic Market Research toolsInspect
Try in Browser
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources