Skip to main content
Glama

Minds: Synthetic Market Research

Export Study Results

export_study

Starts an asynchronous export of Study results and returns an export job ID. Supports executive briefs and full reports in PDF, DOCX, PPTX, or Markdown, plus raw data in CSV, XLS, or SPSS SAV.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
kindNoReport kind. Defaults to full_report, except CSV/XLS/SAV which default to raw_data.
forceNoRegenerate instead of returning a cached artifact.
studyNoWhich Study to export. Omit entirely to use the active Study from this MCP session.
formatNoExport format: "pdf" (default), "docx", "pptx", "csv", "xls", "sav", or "md" (also accepts "markdown"). Executive-summary and full-report PPTX exports use a slide-native 16:9 layout.
lengthNoRequested report detail for executive_brief and full_report exports.
scheduledRunIdNoExport only the messages produced by one scheduled run of this Study, instead of the whole timeline. Use the run ID from the Study schedule history.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
kindNoExport kind.
jobIdNoAsynchronous export job; poll it with get_study_status.
formatNoExport format.
statusNoExport job status.
studyIdNoExported Study.
downloadUrlNoDownload link, once the export is ready.
workspaceUrlNoMinds workspace link for the Study.

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). Omit both panelId and panelName only when exporting the active Study from this MCP session.",
      -  "type": "string"
      -}
    • removedInput schema / properties / panelName
      Removed value: -{
      -  "description": "Study name (fuzzy matched; legacy wire field name: panelName). Omit both panelName and panelId only when exporting the active Study from this MCP session.",
      -  "type": "string"
      -}
    • addedInput schema / properties / study
      Added value: +{
      +  "description": "Which Study to export. Omit entirely to use the active Study from this MCP session.",
      +  "properties": {
      +    "id": {
      +      "description": "Study ID (UUID). Omit with studyName to export the active Study.",
      +      "type": "string"
      +    },
      +    "name": {
      +      "description": "Study name (fuzzy matched among the newest 1,000 visible Studies; use studyId for older records). Omit with studyId to export the active Study.",
      +      "type": "string"
      +    }
      +  },
      +  "type": "object"
      +}
    • removedInput schema / properties / studyId
      Removed value: -{
      -  "description": "Study ID (UUID). Omit with studyName to export the active Study.",
      -  "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). Omit with studyId to export the active Study.",
      -  "type": "string"
      -}
  2. Changed1 schema field changed
    • changedInput schema / properties / studyName / description
      Previous value: -"Study name (fuzzy matched). Omit with studyId to export the active Study."New value: +"Study name (fuzzy matched among the newest 1,000 visible Studies; use studyId for older records). Omit with studyId to export the active Study."
  3. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "$schema": "http://json-schema.org/draft-07/schema#",
      +  "additionalProperties": {},
      +  "properties": {
      +    "downloadUrl": {
      +      "description": "Download link, once the export is ready."
      +    },
      +    "format": {
      +      "description": "Export format."
      +    },
      +    "jobId": {
      +      "description": "Asynchronous export job; poll it with get_study_status."
      +    },
      +    "kind": {
      +      "description": "Export kind."
      +    },
      +    "status": {
      +      "description": "Export job status."
      +    },
      +    "studyId": {
      +      "anyOf": [
      +        {
      +          "type": "string"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "description": "Exported Study."
      +    },
      +    "workspaceUrl": {
      +      "anyOf": [
      +        {
      +          "type": "string"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "description": "Minds workspace link for the Study."
      +    }
      +  },
      +  "type": "object"
      +}
  4. Changed2 schema fields changed
    • changedInput schema / properties / format / description
      Previous value: -"Export format: \"pdf\" (default), \"html\" or \"png\" for executive summaries, \"docx\", \"pptx\", \"csv\", \"xls\", \"sav\", or \"md\" (also accepts \"markdown\"). Executive-summary PPTX exports use a slide-native 16:9 layout."New value: +"Export format: \"pdf\" (default), \"docx\", \"pptx\", \"csv\", \"xls\", \"sav\", or \"md\" (also accepts \"markdown\"). Executive-summary and full-report PPTX exports use a slide-native 16:9 layout."
    • changedInput schema / properties / format / enum
      Previous value: -[
      -  "pdf",
      -  "html",
      -  "png",
      -  "docx",
      -  "pptx",
      -  "csv",
      -  "xls",
      -  "sav",
      -  "md",
      -  "markdown"
      -]New value: +[
      +  "pdf",
      +  "docx",
      +  "pptx",
      +  "csv",
      +  "xls",
      +  "sav",
      +  "md",
      +  "markdown"
      +]
  5. Added

TDQS

A4.1/5.0
Behavior4/5

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

It discloses the asynchronous execution model and the job-ID return, which are not visible in the annotations. It does not describe job lifecycle, caching side effects, or permissions, but the schema's force parameter hints at caching; overall this is useful behavioral context beyond the structured hints.

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, no filler; the async behavior and job ID are front-loaded, and the supported format matrix follows. Every clause earns its place.

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

Completeness5/5

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

Given the fully self-describing schema (100% coverage, enums, nested object, defaults) and the presence of an output schema, the description provides the high-level contract an agent needs: async, job-ID-returning export with a clear format/kind matrix. No critical invocation detail is missing at the description level.

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 all six parameters, enums, defaults, and the nested study object. The description mentions the supported formats and report kinds, but that information is already present in the schema and adds no new parameter-level meaning.

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 action (starts an asynchronous export), the resource (Study results), and the returned artifact (export job ID). This clearly separates it from sibling export tools that target audiences, heatmaps, or mind maps.

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?

The description makes it clear the tool is for Study-result exports, but it does not explicitly state when to prefer it over export_audience, export_heatmap, or export_mind, nor does it list any exclusions. Usage is implied by the resource name and format list, not spelled out.

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.