Skip to main content
Glama
christianclaudio

mcp-server-sigma

Workbooks Export And Download

workbooks_export_and_download

Export Sigma workbook or element data to CSV, PDF, XLSX, or PNG and download the resulting file. Polls until ready and returns base64 content.

Instructions

Export a workbook/element and download the result. Polls until ready.

format: 'csv', 'pdf', 'xlsx', 'png'. layout: 'portrait' or 'landscape' (pdf only). parameters: Sigma control overrides e.g. {'DateRange': 'min:2024-01-01,max:2024-01-31'}. max_bytes: maximum allowed response size (default 10 MB). Returns size info without content if exceeded. Returns base64-encoded file content on success.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
formatNocsv
layoutNoportrait
max_bytesNo
element_idNo
parametersNo
workbook_idYes
timeout_secondsNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv2.0.4

TDQS

A3.7/5.0
Behavior4/5

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

Annotations declare a non-read-only, open-world, non-destructive operation, and the description usefully adds behavior beyond that: it polls until ready (async lifecycle), truncates to size-info when max_bytes is exceeded, and returns base64-encoded content on success. The timeout_seconds parameter is undocumented behaviorally, which keeps it short of a 5.

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?

Front-loads the core action in one sentence, then adds compact per-parameter notes with no filler. Every line carries information an agent needs; nothing is redundant with the schema.

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?

An output schema exists, so return values need not be fully explained, and the description still notes the base64 payload shape. Combined with the format/layout/parameters/max_bytes coverage, an agent has enough to call it correctly; only timeout_seconds and element_id semantics are left entirely to the bare schema.

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?

Schema description coverage is 0%, so the description must carry the burden and largely does: it enumerates the format values (csv/pdf/xlsx/png), restricts layout to pdf, gives a concrete parameters override example, and explains max_bytes default and overflow behavior. It omits element_id and timeout_seconds, so it does not fully compensate for the 7-param, 0%-coverage schema.

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?

States a specific verb+resource: 'Export a workbook/element and download the result.' An agent can tell this is a produce-and-fetch tool. However, it never differentiates itself from the very close siblings 'workbooks_export_workbook' and 'workbooks_download_query_export', which an agent could easily confuse it with.

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

Usage Guidelines2/5

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

The description gives no when-to-use vs. when-not guidance and never names an alternative. 'Polls until ready' implies a long-running/blocking operation, which is mild usage context, but nothing tells the agent why to pick this over workbooks_export_workbook or workbooks_download_query_export.

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

Deploy Server

Other Tools