Skip to main content

Tool Scoping

The Tableau MCP server can be configured to limit the scope of its tools to a set of data sources, workbooks, or projects.

Enabling tool scoping can cause:

  1. Tools to return an error if they are called with arguments that are not within the allowed scope.
  2. Tools to respond with results that have been filtered to only include content from the allowed scope.

Examples use-cases​

  • Only allow clients to query a single data source with the Query Data Source tool. A client attempting to query any other data source will result in an error.
  • Filter the results of the List Workbooks tool to only include workbooks that exist in a single project. Workbooks from other projects will not be included in the results.

Environment variables​

The following optional environment variables can be used to configure the tool scoping.

INCLUDE_PROJECT_IDS​

A comma-separated list of project IDs by which to constrain tool arguments and results. Only data sources and workbooks (or views from those workbooks) that are members of the provided projects can be queried or will be included in the results of the tools.

Example: d87d843b-4326-4ce3-bc50-a68c1e6c9ca5

warning

To constrain the results of the Search Content tool by project, you must also provide the project ID found in the project's URL in the Explore section of your Tableau site e.g. 861566 from https://10ax.online.tableau.com/#/site/my-site/projects/861566

Example: d87d843b-4326-4ce3-bc50-a68c1e6c9ca5,861566

INCLUDE_DATASOURCE_IDS​

A comma-separated list of data source IDs by which to constrain tool arguments and results. Only data sources or Pulse metrics and definitions derived from those data sources can be queried or will be included in the results of the tools.

  • When set, cannot be empty.
  • Data source IDs can be determined using the Query Data Sources REST API or the List Data Sources tool (assuming tool scoping is disabled).
  • Has no impact on tools that return information about workbooks or views.

Example: 2d935df8-fe7e-4fd8-bb14-35eb4ba31d4

INCLUDE_WORKBOOK_IDS​

A comma-separated list of workbook IDs by which to constrain tool arguments and results. Only workbooks or views from those workbooks can be queried or will be included in the results of the tools.

  • When set, cannot be empty.
  • Workbook IDs can be determined using the Query Workbooks REST API or the List Workbooks tool (assuming tool scoping is disabled). The List Views tools also return workbook IDs.
  • Has no impact on the results of the Pulse-related tools.

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