Skip to main content

Download Workbook

Downloads workbook content from Tableau as either an unpackaged TWB XML file or a packaged TWBX file.

APIs called​

Required arguments​

workbookId​

The ID of the workbook to download, potentially retrieved by the List Workbooks tool.

Example: 222ea993-9391-4910-a167-56b3d19b4e3b

Optional arguments​

includeExtract​

Whether to include workbook extracts in the returned package when available.

Example: true

Response behavior​

The tool returns one of two result shapes:

  • MCP_S3_BUCKET set: returns a resource_link with a short-lived presigned URL to the workbook file.
  • MCP_S3_BUCKET unset 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"
}