Skip to main content

Publish Workbook

Available November 2026 and later.

Opens the Publish Workbook dialog so the workbook open in the connected Tableau Studio instance can be published to the signed-in Tableau site. The dialog is interactive: a returned success means the flow was launched, not that a publish landed — dismissing or cancelling the dialog also succeeds. Requires being signed in to a site.

Not read-only

This tool is not read-only and is not idempotent. Opening the dialog reaches a remote Tableau site (openWorld).

APIs called​

This tool acts on the workbook open in the running Tableau Studio instance. Opening the dialog is a call to the local Tableau Studio External Client API — a REST API the running Tableau Studio instance serves at http://127.0.0.1:<port>/v<x>, where <x> is the latest API version. There are no OAuth scopes on that loopback call: it is authorized by the running Tableau Studio instance's per-session bearer token. Completing publish in the dialog then talks to the connected Tableau site from Tableau Studio itself; this MCP tool does not call the Tableau Cloud or Server REST API.

  • Settles on which Tableau Studio session to target before anything is sent. Resolved in-process (not an API call).
  • Asks Tableau Studio to open the Publish Workbook dialog for the open workbook. Requires a connected session with an open workbook and a signed-in site; authorized by that session's loopback bearer token.
    • POST /v<x>/workbook:publish — open the Publish Workbook dialog. API reference

Optional arguments​

session​

Identifier of the target Tableau Studio session. When omitted, the session is resolved automatically (for example, when it is pinned or exactly one Tableau Studio instance is connected).

Example​

"studio-1"

Notes and caveats​

  • Launch is not publish. completed means the dialog was opened; finish or cancel it in Tableau Studio. If Tableau Studio accepts the request before the dialog has settled, the result says the open was requested and is still being applied.

Example results​

Dialog opened​

{ "message": "Opened the Publish Workbook dialog; finish or cancel it in Tableau." }

Accepted, still being applied​

{ "message": "Requested opening the Publish Workbook dialog; Desktop is still applying it." }
  • save-workbook — save the open workbook to disk without publishing.

One of workbookUploadId or workbookFilePath​

Exactly one of these must be provided — providing both, or neither, returns an error.

workbookUploadId​

The staged workbook upload id returned by Request Workbook Upload. Use this for hosted clients that cannot pass a local path. Requires MCP_S3_BUCKET to be configured.

Example: 123e4567-e89b-42d3-a456-426614174000

workbookFilePath​

Path to a local TWB or TWBX workbook file on the MCP server's filesystem. Only supported when staged S3 uploads are not configured (i.e. MCP_S3_BUCKET is unset).

Example: /path/to/Superstore.twbx

Destination: projectId or Personal Space​

projectId​

The Tableau project LUID to publish the workbook into. Use List Projects with capability: "Write" to discover the projects you can publish to. If this MCP server is configured with a bounded project context, publishing to a project outside that context returns an error instead of publishing. When provided, it is always used and personalSpace is ignored.

Example: cbec32db-a4a2-4308-b5f0-4fc67322f359

personalSpace​

This parameter is advertised only when data-apps is enabled.

Defaults to true. When projectId is omitted, the workbook is published into your Personal Space. The tool resolves the caller's Personal Space LUID automatically and sends it as a location to Tableau; do not pass a Personal Space LUID as projectId.

  • projectId provided: published to that project; personalSpace is ignored.
  • projectId omitted and personalSpace true or omitted: published to your Personal Space.
  • projectId omitted and personalSpace: false: returns an error asking for projectId.

The tool never falls back to a shared or default project.

The bounded project context is not applied to the caller's own Personal Space; it continues to gate only projectId. Personal Space resolution requires the tableau:projects:read OAuth scope, which is included in the tool's publish scope set.

Example Personal Space request:

{
"name": "Q3 Sales Overview",
"workbookFilePath": "/path/to/Superstore.twbx"
}

For Personal Space publishes, the tool returns an error without publishing anything if:

  • your Personal Space could not be resolved,
  • your Personal Space is read-only, or
  • the site has direct-to-personal-space publishing disabled.

In addition, some servers accept the request but silently land the workbook in a default project instead of honoring the Personal Space target. In that case the workbook is actually published — just to an unintended location — and the tool still returns an error so you can delete it there if unwanted, or republish by passing an explicit projectId.

Response behavior​

The tool returns one of two result shapes:

  • status: "published": the workbook was validated (TWB) or uploaded (TWBX) and published successfully. Includes the published workbook's data, its url, and any non-blocking warnings from validation.
  • status: "invalid": validation found blocking errors (TWB only). Nothing was published. warnings are still included alongside errors.

Permissions after a project publish​

A successful project publish attempts an optional permissions read and returns permissions: the workbook's configured user/group permission rules. These rules are returned unchanged in both structuredContent and the JSON text content. The tool does not select an access message or append a published-data-source reminder; the authoring skill interprets the output using existing task context.

If the optional read fails, publishing still succeeds and permissionsNote explains that the rules could not be retrieved. Personal Space publishes skip the read and omit both permission fields. Project permission disclosure is independent of the data-apps flag. See Feature Flags.

Publish outcomePermission fields
Project publish; permission read succeedspermissions contains the returned rules, including an empty array if none were returned.
Project publish; permission read fails or consent is unavailablepermissionsNote explains the unavailable read; permissions is absent.
Project publish; data-apps disabledSame permission read and fields as any other project publish.
Personal Space publishNeither field is returned; no permission read occurs.

An omitted capability is not rewritten as a denial. An empty array means no configured rules were returned, not that nobody has access. The rules do not determine each viewer's effective access, and successful publishing does not verify permissions on a published parent data source.

Example result (published)​

{
"status": "published",
"data": {
"id": "222ea993-9391-4910-a167-56b3d19b4e3b",
"name": "Q3 Sales Overview",
"webpageUrl": "https://10ax.online.tableau.com/#/site/mcp-test/workbooks/1412200",
"contentUrl": "Q3SalesOverview",
"project": {
"id": "cbec32db-a4a2-4308-b5f0-4fc67322f359",
"name": "Marketing Analytics"
}
},
"url": "https://10ax.online.tableau.com/#/site/mcp-test/views/Q3SalesOverview/Overview",
"warnings": [
{
"severity": "WARNING",
"message": "Unknown map source is used",
"line": 245,
"column": 18,
"elementName": "map"
}
]
}

Example result (invalid)​

{
"status": "invalid",
"errors": [
{
"severity": "ERROR",
"message": "Unable to connect to the data source",
"line": 12,
"column": 4,
"elementName": "preferences"
}
],
"warnings": []
}