Skip to main content
Glama

Cancel DataLens workbook export

datalens_workbookexports_cancel
Idempotent

Cancel a running DataLens workbook export by export_id. It marks the export as error with WORKBOOK_EXPORT_CANCELLED; completed exports remain unchanged.

Instructions

Stop an export: its status becomes error, with WORKBOOK_EXPORT_CANCELLED.

An export that is over stays as it ended, and the call answers the same.

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.6/5.0
Behavior4/5

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

Provides useful behavioral context beyond the annotations: the export status becomes 'error' with code 'WORKBOOK_EXPORT_CANCELLED', and a finished export remains unchanged while the call still succeeds. The annotations already cover idempotency and destructiveness at a high level, so this is valuable added detail rather than a complete behavioral disclosure.

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 tightly written sentences with no wasted words. The cancellation effect is front-loaded, and the idempotency nuance follows immediately without redundancy.

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?

For a simple one-parameter cancellation tool with no output schema, the description covers the essential outcome and the edge case where the export has already completed. It does not need to explain return values, and the annotations already cover the safety profile.

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?

The schema coverage is 100% and the single parameter 'export_id' is already documented as coming from 'workbookexports_start.' The description adds no parameter-level semantics, which is acceptable when the schema fully covers the parameter.

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: 'Stop an export.' The outcome is clearly described. However, it does not explicitly name sibling tools or clarify why this is distinct from status/result retrieval beyond the cancellation effect.

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?

Only implies usage through the imperative 'Stop an export.' There is no explicit when-to-use guidance, no when-not-to-use guidance, and no mention of alternatives like checking status or retrieving results before cancelling.

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