Tableau MCP is a suite of developer primitives, including tools, resources and prompts, that will make it easier for developers to build AI-applications that integrate with Tableau.
Key features:
- Provides access to Tableau published data sources through the VizQL Data Service (VDS) API
- Supports collecting data source metadata (columns with descriptions) through the Tableau Metadata API
- Usable by AI tools which support MCP Tools (e.g., Claude Desktop, Cursor and others)
- Works with any published data source on either Tableau Cloud or Tableau Server
The following MCP tools are currently implemented:
Variable | Description |
---|---|
list-datasources | Retrieves a list of published data sources from a specified Tableau site (REST API) |
list-fields | Fetches field metadata (name, description) for the specified datasource (Metadata API) |
query-datasource | Run a Tableau VizQL query (VDS API) |
read-metadata | Requests metadata for the specified data source (VDS API) |
Note: The Tableau MCP project is currently in early development. As we continue to enhance and refine the implementation, the available functionality and tools may evolve. We welcome feedback and contributions to help shape the future of this project.
Follow these steps to install Tableau MCP for the first time:
- Clone the repository
- Install Node.js (tested with 22.15.0 LTS)
npm install
npm run build
To keep up with repo changes:
- Pull latest changes:
git pull
npm install
npm run build
- Relaunch your AI tool or 'refresh' the MCP tools
To use the Docker version of Tableau MCP, build the image from source:
$ docker build -t tableau-mcp .
$ docker images
REPOSITORY TAG IMAGE ID CREATED SIZE
tableau-mcp latest c721228b6dd3 15 hours ago 260MB
Remember to build the Docker image again whenever you pull the latest repo changes. Also you'll need to relaunch your AI tool so it starts using the updated image.
Tableau MCP works with both Tableau Server and Tableau cloud data with these prerequisites:
- Only published data sources are supported
- VDS (VizQL Data Service) must be enabled (Tableau Server users may need to enable it)
- Metadata API must be enabled (Tableau Server users may need to enable it)
Tableau MCP requires authentication in order to connect with your Tableau Server or Tableau Cloud site. This authenticated user must have access to the published data source(s) you plan to access.
Provide your Tableau Personal Access Token by setting the PAT_NAME
and PAT_VALUE
environment variables. See Environment Variables for more information.
AI tools can connect to Tableau MCP in two different ways:
- Running locally: the tool runs Tableau MCP as needed using
node build/index.js
- Running in Docker: the tool runs Tableau MCP as a Docker container
Either method will work. The Docker path is slightly easier because all the environment variables are stored in one file rather than in each AI tool's config section.
Depending on your desired mode, create your environment configuration as follows:
For running locally, create an mcpServers
JSON snippet using config.example.json
as a
template. It should look similar to this:
{
"mcpServers": {
"tableau": {
"command": "node",
"args": ["/full-path-to-tableau-mcp/build/index.js"],
"env": {
"SERVER": "https://my-tableau-server.com",
"SITE_NAME": "",
"PAT_NAME": "",
"PAT_VALUE": "",
... etc
}
}
}
}
For running with Docker, create an env.list
file in the root of the project using
env.example.list
as a template. Also create an mcpServers
JSON snippet like
config.docker.json
. It should look similar to this:
{
"mcpServers": {
"tableau": {
"command": "docker",
"args": [
"run",
"-i",
"--rm",
"--env-file",
"/full-path-to-tableau-mcp/env.list",
"tableau-mcp"
]
}
}
}
These config files will be used in tool configuration explained below.
Variable | Description |
---|---|
SERVER |
The URL of the Tableau server. |
SITE_NAME |
The name of the Tableau site to use. For Tableau Server, set this to an empty string to specify the default site. |
PAT_NAME |
The name of the Tableau Personal Access Token to use for authentication. |
PAT_VALUE |
The value of the Tableau Personal Access Token to use for authentication. |
Variable | Description | Default | Note |
---|---|---|---|
DEFAULT_LOG_LEVEL |
The default logging level of the server. | debug |
|
DATASOURCE_CREDENTIALS |
A JSON string that includes usernames and passwords for any datasources that require them. | Empty string | Format is provided in the DATASOURCE_CREDENTIALS section below. |
DISABLE_LOG_MASKING |
Disable masking of credentials in logs. For debug purposes only. | false |
|
INCLUDE_TOOLS |
A comma-separated list of tool names to include in the server. Only these tools will be available. | Empty string (all are included) | For a list of available tools, see toolName.ts. |
EXCLUDE_TOOLS |
A comma-separated list of tool names to exclude from the server. All other tools will be available. | Empty string (none are excluded) | Cannot be provided with INCLUDE_TOOLS . |
MAX_RESULT_LIMIT |
If a tool has a "limit" parameter and returns an array of items, the maximum length of that array. | Empty string (no limit) | A positive number. |
The DATASOURCE_CREDENTIALS
environment variable is a JSON string that includes usernames and
passwords for any datasources that require them. The format is:
{"ds-luid1":[{"luid":"ds1-connection-luid1","u":"username1","p":"password1"},{"luid":"ds1-connection-luid2","u":"username2","p":"password2"}],"ds-luid2":[{"luid":"ds2-connection-luid1","u":"username3","p":"password3"}]}
This is a JSON-stringified version of the following object:
{
"ds-luid1": [
{ luid: "ds1-connection-luid1", u: "username1", p: "password1" },
{ luid: "ds1-connection-luid2", u: "username2", p: "password2" }
],
"ds-luid2": [
{ luid: "ds2-connection-luid1", u: "username3", p: "password3" }
]
}
The connection LUIDs can be determined using the Query Data Source Connections REST API. Future work will include a tool to automate this process. For more information, see Connect to your data source.
The MCP Inspector is a helpful tool to confirm your configuration is correct and to explore Tableau MCP capabilities.
Create a config.json
file in the root of the project using config.example.json
as a template.
(Docker users can skip this step.)
After building the project and setting the environment variables in the env.list
file, you can
start the MCP Inspector using either of the following commands:
Command | Description |
---|---|
npm run inspect |
Start the MCP Inspector which runs the server locally using Node.js. |
npm run inspect:docker |
Start the MCP Inspector which runs the server using a Docker container. |
For Claude, open the settings dialog, select the Developer section, and click Edit Config.
Add the tableau
MCP server to the mcpServers
object in the config using config.example.json
or
config.docker.json
as a template.
For Cursor, create a configuration file .cursor/mcp.json
in your project directory (for
project-specific access) or ~/.cursor/mcp.json
in your home directory (for global access across
all projects).
Add the tableau
MCP server configuration using config.example.json
or config.docker.json
as a
template. For more details, see the
Cursor MCP documentation.
For VSCode, create a .vscode/mcp.json
file in your workspace folder (for project-specific access)
or add the server configuration to your user settings (for global access across all workspaces).
Add the tableau
MCP server configuration using config.example.json
or config.docker.json
as a
template. For more details, see the
VSCode MCP documentation.
We are following the fork and pull model where contributors will make their own fork of this repo, implement their changes, and then submit a pull request here.
Refer to the Contribution Checklist for more details on the steps.
You can use the VS Code Run and Debug Launcher to run and debug the server.
To set up local debugging with breakpoints:
-
Store your environment variables in the VS Code user settings:
-
Open the Command Palette (F1 or Cmd/Ctrl + Shift + P).
-
Type
Preferences: Open User Settings (JSON)
. -
This should open your user's
settings.json
file. -
Copy the environment variables from
.vscode/settings.example.json
, append them to the JSON blob in your user'ssettings.json
file, and update their values accordingly:"tableau.mcp.SERVER": "https://my-tableau-server.com", ...
-
-
Set breakpoints in your TypeScript files.
-
Locate and click the
Run and Debug
button in the Activity Bar. -
Select the configuration labeled "
Launch MCP Server
" in the dropdown. -
Click the Start Debugging
▶️ button, or press F5.