Skip to main content

Download Workbook

Available November 2026 and later.

Downloads workbook content as a TWB (application/xml) or TWBX (application/octet-stream) file. The returned file metadata includes Tableau-provided content type and filename when available. If the user asks to open the workbook file locally, derive the full Tableau Studio application path instead of assuming it is named exactly "Tableau Studio". If multiple Tableau Studio versions are installed, select the most recent version by comparing version numbers in the application filename/path.

APIs called​

Talks to Tableau Cloud or Tableau Server.

  • Downloads workbook content as a TWB (application/xml) or TWBX (application/octet-stream) file.

Required arguments​

workbookId​

The workbookId argument.

Optional arguments​

includeExtract​

Whether to include workbook extracts in the returned workbook package.

Response behavior​

The tool returns one of two result shapes:

  • S3 file mode enabled: returns a resource_link with a short-lived presigned URL to the workbook file.
  • S3 file mode disabled or upload failure: writes the workbook to a local temporary directory and returns a JSON object containing a local file path.

The tool preserves Tableau response metadata when present:

  • mimeType is typically:
    • application/xml for .twb
    • application/octet-stream for .twbx
  • name (for resource_link) and filename (for temp-file JSON) are taken from Tableau's Content-Disposition filename when available, otherwise a fallback name is generated.

Example result (S3 mode)​

{
"type": "resource_link",
"uri": "https://example-bucket.s3.amazonaws.com/...presigned...",
"name": "Superstore.twbx",
"mimeType": "application/octet-stream",
"description": "Downloaded Tableau workbook content stored in S3. This is a short-lived presigned URL."
}

Example result (temp-file fallback)​

{
"path": "/var/folders/.../tableau-mcp-workbooks/0c831313-bf52-4eb8-b087-8f4d37b6cb49-Superstore.twbx",
"filename": "Superstore.twbx",
"mimeType": "application/octet-stream"
}