Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/docs/extras/deploy-heroku.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 2
sidebar_position: 3
---

# Deploy to Heroku
Expand Down
9 changes: 9 additions & 0 deletions docs/docs/extras/docker.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
sidebar_position: 1
---

# Docker

See [Tableau MCP Docker Container][link] for installation instructions.

[link]: https://github.com/tableau/tableau-mcp/pkgs/container/tableau-mcp
46 changes: 4 additions & 42 deletions docs/docs/getting-started.md → docs/docs/extras/node-sea.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,45 +2,7 @@
sidebar_position: 2
---

# Getting Started

## Quick Start

Requirements

- Node.js 22.7.5 or newer
- An MCP client e.g. Claude Desktop, Cursor, VS Code, MCP Inspector, etc.

This standard config works in most MCP clients:

```json
{
"mcpServers": {
"tableau": {
"command": "npx",
"args": ["-y", "@tableau/mcp-server@latest"],
"env": {
"SERVER": "https://my-tableau-server.com",
"SITE_NAME": "my_site",
"PAT_NAME": "my_pat",
"PAT_VALUE": "pat_value"
}
}
}
}
```

<hr />

## Docker Container

See
[Tableau MCP Docker Container](https://github.com/tableau/tableau-mcp/pkgs/container/tableau-mcp)
for installation instructions.

<hr />

## Node.js Single Executable Applications
# Node.js Single Executable Applications

Node.js [Single Executable Applications](https://nodejs.org/api/single-executable-applications.html)
(SEA) are a way to package a Node.js application into a single executable file.
Expand All @@ -49,7 +11,7 @@ This provides a simple method for administrators to deploy Tableau MCP to their
to install Node.js or any other dependencies. Tableau MCP is available as a SEA for both Windows and
Linux.

### Windows
## Windows

Run [Manage-Server.ps1](https://github.com/tableau/tableau-mcp/blob/main/scripts/Manage-Server.ps1).

Expand Down Expand Up @@ -95,15 +57,15 @@ iwr -Uri "https://raw.githubusercontent.com/tableau/tableau-mcp/refs/heads/main/

:::

### Linux or Manual Windows Installation
## Linux or Manual Windows Installation

1. Go to the latest [Tableau MCP release][releases] on GitHub
2. Under Assets, download the `tableau-mcp.zip` (Windows) or `tableau-mcp.tar.gz` (Linux) archive
for your operating system.
- If no archives exist, the release is too old and you'll need to choose a newer release.
3. Extract the archive
4. Create a [.env](https://www.dotenv.org/docs/security/env.html) file with your Tableau MCP
settings. See [Environment Variables](./configuration/mcp-config/env-vars.md) section for more
settings. See [Environment Variables](../configuration/mcp-config/env-vars.md) section for more
details.
5. Run the application

Expand Down
262 changes: 262 additions & 0 deletions docs/docs/getting-started/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,262 @@
# Getting Started

This guide walks through getting started with Tableau MCP to integrate Tableau data with AI tools
for natural language data analysis and querying. These instructions are written for a general
audience and work equally well with published datasources located on either Tableau Cloud or Tableau
Server.

Tableau MCP GitHub project links:

- Code repository: https://github.com/tableau/tableau-mcp
- Documentation: https://tableau.github.io/tableau-mcp/

## Overview

[Tableau MCP](https://github.com/tableau/tableau-mcp) is an open source GitHub project that uses the
[Model Context Protocol](https://modelcontextprotocol.io/introduction) standard for simplifying
agent-to-Tableau communication, enabling users to bring their Tableau data into AI tools by
leveraging VizQL Data Service, Metadata API, and other Tableau APIs.

This guide walks you through everything you need to explore Tableau data via MCP using
[Claude Desktop](https://claude.ai/download) (the free version is all that's needed). Once it's
running you'll be able to explore data like this example:

![Claude Desktop](images/claude-desktop.png)

### Basic Architecture

In this setup, Tableau MCP runs locally on your computer as a separate process that Claude Desktop
will communicate with directly using its standard input/output streams.

```mermaid
---
config:
layout: dagre
theme: default
---
flowchart TB
subgraph root["Your computer"]
direction TB
subGraph0["subGraph0"]
subGraph1["subGraph1"]
end
subgraph subGraph0["Host (e.g. Claude Desktop)"]
client1["MCP Client"]
end
subgraph subGraph1["Server Process"]
server1["Tableau MCP Server"]
end
subgraph subGraph2["Tableau Server/Cloud"]
vds["VizQL Data Service"]
metadata["Tableau Metadata API"]
end
client1 <-- Stdio Transport Layer --> server1
server1 <-- HTTP --> vds & metadata
style subGraph0 fill:#BBDEFB
style subGraph1 fill:#BBDEFB
style subGraph2 fill:#BBDEFB
```

## Setup

### Identify Tableau Server or Cloud Site

Tableau MCP works with published data sources on Tableau Servers or Tableau Cloud Sites.

To connect with your data, you'll need to create a Personal Access Token (PAT) to use with MCP.

:::info

If you don't already have a Tableau Cloud/Server site, it's easy to get a free one for testing by
joining the [Tableau Developer Program](https://www.tableau.com/developer). Click the join button
and follow the steps.

:::

Login to your site, then click your profile in the upper right to bring up My Account Settings.

Scroll down to Personal Access Tokens and create a new one. You can use any token name but something
memorable like "mcp" is suggested to make later configuraton easier. Make sure to copy and save the
value because it's only shown this one time. (Also, be aware that Tableau PATs will expire after 15
days of inactivity, so you may need to periodically create a new one.)

![Personal Access Token Config](images/pat.png)

:::warning

Keep your PAT safe and don't share with anyone or check into source control. Pay attention to the
expiration date. You can also return here to revoke the token when you no longer need it.

:::

Make note of these 4 values which you'll need later for the MCP configuration:

- SERVER (e.g. https://10ax.online.tableau.com or https://tableau.example.com)
- SITE_NAME (e.g. techandprod; on Server leave blank to use the default site)
- PAT_NAME (e.g. mcp)
- PAT_VALUE (value copied after PAT creation)

### Identify a Published Data Source

Tableau MCP works with both Tableau Server and Tableau Cloud data sources with these prerequisites:

- Only published data sources are supported
- Tableau Server users must
[enable VDS (VizQL Data Service)](https://help.tableau.com/current/server-linux/en-us/cli_configuration-set_tsm.htm#featuresvizqldataservicedeploywithtsm)
- Tableau Server users must
[enable the Metadata API](https://help.tableau.com/current/api/metadata_api/en-us/docs/meta_api_start.html#enable-the-tableau-metadata-api-for-tableau-server)
- Your user must have
[API Access enabled](https://help.tableau.com/current/api/vizql-data-service/en-us/docs/vds_configuration.html)
on the data source
- Tableau Cloud users must
[enable Tableau Pulse](https://help.tableau.com/current/online/en-us/pulse_set_up.htm) on your
site to use Pulse API tools (Tableau Server is unable to use Tableau Pulse)

If you don't have a published data source, you can create one like Superstore or by uploading a
CSV/Excel file and creating a published version of it.

To use a published data source with MCP, you just need to refer to it by name in the AI tool (like
Claude). See below for examples.

### Install Claude Desktop

Start by downloading and installing [Claude Desktop](https://claude.ai/download) (Mac or Windows).
Claude requires an account, so you'll need to sign up with your email address. A free account should
suffice for simple testing with a limited number of messages (details:
[Getting started with Claude | Claude Help Center](https://support.claude.com/en/articles/8114491-getting-started-with-claude#h_57262af5ae)).
If you run into problems exceeding the free limit, you can upgrade to
[Claude Pro](https://support.claude.com/en/articles/11049762-choosing-a-claude-plan) for $20/month.

### Install Tableau MCP Extension

Tableau MCP can be run several different ways. Perhaps the easiest is running the pre-built Claude
Desktop Extension.

Option 1: Install from Claude Marketplace

1. Open Claude Desktop
2. Go to Settings | Extensions
3. Click on Browse Extensions
4. Search for Tableau and install it

Option 2: Install latest from Tableau MCP GitHub

1. Go to the [Releases page](https://github.com/tableau/tableau-mcp/releases)
2. For the newest release, under Assets, find and download the .mcpb file (it will be named
something like "tableau-mcp-v1.15.0.mcpb")
3. Open Claude Desktop
4. Go to Settings | Extensions
5. Drag and drop the .mcpb file onto Claude Desktop

Once the extension is installed, you'll be prompted to configure Tableau MCP:

- SERVER
- Cloud: pod hostname like https://10ax.online.tableau.com
- Server: hostname like https://tableau.example.com
- SITE_NAME
- Cloud: required, for example techandprod
- Server: site name, or can leave blank to use the default site
- PAT_NAME (e.g. mcp)
- The name of the PAT you created in the Tableau site settings
- PAT_VALUE (value copied after PAT creation above)

When everything is configured it should look like this:

![Claude Desktop Extension configuration](images/dxt-config.png)

## Using Claude with MCP

### List Datasources

To verify that Claude is talking to Tableau correctly, start a new chat and try a question like
"list some of the Tableau datasources". Claude will show a pop-up asking for permission to run the
list-datasources tool, then you should see a result like this:

![List Datasources Result](images/list-datasources.png)

For any datasource it lists, you can ask it to explain it in more detail and even sample some data
if you like.

### Superstore

For large, shared sites, there may be a ton of "Superstore" datasources. To help narrow down to a
specific one, include additional qualifiers in your prompt, like the name of the user who owns it.

![List Datasources With Owner Result](images/list-datasources-with-owner.png)

To peek under the hood and understand how the AI client (Claude) and Tableau MCP are communicating,
you can click to expand any of the tool calls it makes. For example the query above used the List
Datasources tool with a search by name and owner name:

![List Datasources Tool Call Trace](images/list-datasources-trace.png)

In the same chat session you can go deeper and explore the selected data. Asking the model to
explore the data and propose questions is a great cheat code:

![Data Exploration Result 1](images/data-exploration-1.png)

![Data Exploration Result 2](images/data-exploration-2.png)

Here's another example question along with a request to show me visually:

![Data Exploration Result 3](images/data-exploration-3.png)

Claude also created a simple React page to visualize everything, per my request:

![Data Exploration Visualization](images/visualization.png)

Claude calls these Artifacts and because they are single-page web content they can be published and
shared. For example this one is live here:
[discount-profit.jsx | Claude](https://claude.ai/public/artifacts/58c7eee0-55a1-4e12-aa8b-c512d88076f9).

Claude can also create other kinds of visualizations directly or by creating code snippets to do the
same.

## Explore Further

Follow along and share ideas with the Tableau MCP team by creating issues or discussions on the
repository. You can also join the [Tableau Developer Platform](https://www.tableau.com/developer)
and reach out in the [#tableau-ai-solutions](https://tableau-datadev.slack.com/archives/C07LMAVG4N6)
Slack channel in the Tableau #DataDev workspace.

The MCP project is still under development and new tools (Tableau APIs) are being regularly added.
See the README at https://github.com/tableau/tableau-mcp for the latest.

We used Claude Desktop in this example, but any MCP client should work. People on our team have used
Cursor, VS Code, and other tools. The configuration for most of these follows the same pattern as
used above ("mcpServers" defined in JSON). The
[Tableau MCP documentation](https://tableau.github.io/tableau-mcp/) has more details about different
ways to configure and run, including all of the optional environment variables.

If you try a tool that doesn't quite work, please reach out to the team to let us know.

## Troubleshooting

Here are some common issues that might come up – and how to solve them. The examples and screenshots
are from Claude Desktop but can apply similarly with any AI tools.

### 401 Unauthorized

When the AI client is using tools through Tableau MCP, it might fail and report a "401 Unauthorized"
error.

![401 Unauthorized Error](images/401-error.png)

Solutions:

- Double-check that the server URL and site are correct
- For PAT_NAME, ensure you are providing the **name** of the PAT, not your username or email address
- Generate a new personal access token (PATs can
[expire after 15 days if not used](https://help.tableau.com/current/server/en-us/security_personal_access_tokens.htm#change-personal-access-tokens-expiry))

### 403 Forbidden

For Tableau MCP to work, the user must have the "API access" permission enabled. In cases where the
user does not have that permission, a "403 Forbidden" error can occur.

![403 Forbidden Error](images/403-error.png)

Solution:

- Grant API access to your user for that specific data source
- More likely, request that the admin or project owner do that for you
4 changes: 4 additions & 0 deletions docs/docs/getting-started/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "Getting Started",
"position": 2
}
Binary file added docs/docs/getting-started/images/401-error.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/docs/getting-started/images/403-error.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/docs/getting-started/images/dxt-config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/docs/getting-started/images/pat.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading