Skip to main content
Glama

Get DataLens workbook export result

datalens_workbookexports_result_get
Read-onlyIdempotent

Retrieve a completed workbook export by ID as a single document, ready to pass to workbookimports_start. Returns 409 if the export is unfinished or cancelled.

Instructions

The exported workbook: every entry it holds, as one document.

data is what workbookimports_start takes. An export that is not over, or was cancelled, answers 409 Conflict. The document is large (hundreds of kilobytes for a workbook with a dashboard) and holds no password or token of a connection.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
export_idYesExport id, from ``workbookexports_start``.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.122.1

TDQS

A3.9/5.0
Behavior4/5

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

Annotations already cover readOnly/idempotent/openWorld, so the bar is lower, yet the description still adds real behavior: the 409 failure mode for incomplete or cancelled exports, the payload magnitude (hundreds of KB with a dashboard), and the assurance that no connection secrets are included. That last point is valuable for an agent deciding whether the response is safe to surface.

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 what the tool returns, then the downstream use of ``data``, then the failure mode and size caveat. Three sentences, all earning their place, though the opening line is slightly elliptical ('as one document').

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?

With no output schema, the description must characterize the return, and it does: the document's contents, its rough size, the round-trip use as input to workbookimports_start, and the error condition. It stops short of stating the serialization format, which is the one remaining gap for an agent handling a hundreds-of-KB payload.

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 coverage is 100% and the single export_id is already documented as coming from workbookexports_start, so the schema carries the load. The description adds no syntax or format detail beyond that baseline.

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 resource and its shape: the exported workbook returned as one document holding every entry. This clearly separates it from datalens_workbookexports_status_get (progress) and datalens_workbookexports_cancel, though neither sibling is named explicitly, so an agent must infer the split.

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 409-on-not-finished/cancelled clause tells the agent the export must be complete before calling, which is actionable gating context. It stops short of naming datalens_workbookexports_status_get as the tool to poll first, so the routing is implied rather than explicit.

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