Skip to main content
Glama
christianclaudio

mcp-server-sigma

Workbooks Download Query Export

workbooks_download_query_export
Read-only

Download an exported Sigma query result by query ID. Returns JSON, CSV/text, base64 PDF/XLSX/PNG, or processing status if the query is still running.

Instructions

Download an exported query result file by queryId.

Returns the file content (JSON or text/CSV) or base64 binary (PDF, XLSX, PNG), or reports 'processing' if the query has not finished executing. max_bytes: Maximum allowed payload size in bytes (default 10 MB).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
query_idYes
max_bytesNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv2.0.4

TDQS

A3.6/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false and openWorldHint=true, so the safety profile is covered. The description goes beyond them by disclosing the async lifecycle ('reports processing if the query has not finished executing') and the payload encodings returned, which is genuinely useful operational context.

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?

Three short sentences, front-loaded with the action and key, then behavior, then the parameter note. No filler, though the trailing max_bytes sentence reads slightly detached from the main flow.

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 re-explained, and the async 'processing' state is covered. However, it omits what happens when the payload exceeds max_bytes (truncation vs. error) and where query_id comes from, which are real gaps for a download tool.

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 0%, so the description must carry parameter meaning. It explains max_bytes (size cap in bytes, 10 MB default) though the default is already in the schema, but says nothing about the query_id format or where to obtain it. It compensates for only half the parameters.

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 ('Download an exported query result file') plus the lookup key (queryId), which clearly separates it from the export-side siblings like workbooks_export_workbook and workbooks_export_and_download. It stops short of naming which sibling produces the queryId, so the distinction is implied rather than explicit.

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 only implied: the phrase 'an exported query result file by queryId' suggests a prior export/query execution must have happened, but the description never states prerequisites or when to prefer this over workbooks_export_and_download. No explicit when-to-use or when-not guidance is given.

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