Skip to main content
Glama
christianclaudio

mcp-server-sigma

Workbooks Export Workbook

workbooks_export_workbook

Export a Sigma workbook page or specific element to PDF, PNG, CSV, XLSX, JSON, or JSONL. Omit the element ID to export the first page.

Instructions

Export a workbook element. If element_id is empty, exports the first page.

format: 'pdf', 'png', 'csv', 'xlsx', 'json', 'jsonl'. layout: 'portrait' or 'landscape' (only for pdf/png). element_id: The specific element to export. If omitted, uses the first page element.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
formatNopdf
layoutNoportrait
element_idNo
workbook_idYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv2.0.4

TDQS

A3.5/5.0
Behavior3/5

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

Annotations declare readOnlyHint=false, destructiveHint=false, and openWorldHint=true, so safety is partly covered. The description adds useful constraints (layout only applies to pdf/png, element_id defaults to first page) but never says where the export goes or whether it returns a file reference versus a URL, which matters for a non-read-only tool.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loaded with the core action, then terse per-parameter lines. Efficient, though the fragmented 'format:/layout:' fragments read more like schema notes than prose and could be slightly tightened.

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?

An output schema exists, so return values need not be described. Still, the destination of the export and its relationship to sibling export/download tools are unaddressed, leaving an agent with an incomplete picture for a non-read-only operation.

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 parameter burden and largely does: it enumerates format values, layout values with a format constraint, and explains element_id's fallback semantics. Only workbook_id is left unexplained, though its meaning is self-evident.

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 and resource ('Export a workbook element') with a clear default behavior for the empty element_id case. However, it does not distinguish itself from close siblings like workbooks_export_report, workbooks_export_and_download, or workbooks_download_query_export, leaving the agent to infer the difference.

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 by the export purpose and the element_id fallback rule, but there is no explicit when-to-use or when-not-to-use guidance and no named alternative among the many export/download siblings. The agent gets no routing help.

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