Report cwtwb MCP server version, workbook state, and safe usage guardrails.

Use this when an AI client seems stale, cannot see expected tools, or is about to edit MCP configuration to switch Tableau credentials. This tool never returns secret values.

Publish a .twb/.twbx to Tableau Cloud for openability or screenshots.

Prefer validate_workbook_api for the default cloud semantic validation path because it does not publish or store the workbook. Use upload_workbook only when you explicitly need a published workbook_id, visual screenshot, TWBX packaging validation, or publish/openability evidence.

Args: twb_path: Path to .twb or .twbx file. data_path: Optional data file (.xlsx/.xls/.hyper) to package. name: Workbook name on Tableau Cloud (defaults to filename stem). overwrite: Whether to overwrite existing workbook with same name. env_path: Optional path to a .env file with Tableau credentials. Explicit env_path takes priority over process environment variables.

Returns: {success, workbook_id, workbook_url, views, twbx_path, twbx_size_kb, error}

Validate a .twb file via Tableau Cloud REST API (no publish).

This performs semantic validation that checks whether the workbook will actually open in Tableau — beyond what local XSD schema validation can detect (calculated field formulas, field references, data source connectivity, etc.). The file is NOT stored on the server.

Only .twb files are supported. For .twbx files, use upload_workbook.

Requires Tableau Cloud June 2026+ / Server 2026.2+ (API version 3.29+).

Args: twb_path: Path to .twb file. validation_level: "syntactic" (XSD only) or "semantic" (full, default). env_path: Optional path to a .env file with Tableau credentials. Explicit env_path takes priority over process environment variables.

Returns: {success, validation_level, valid, errors, warnings, error}

Screenshot a published workbook's view for human review.

Use after upload_workbook to capture a visual snapshot. The screenshot is saved locally for human inspection.

Args: workbook_id: The workbook ID returned by upload_workbook. output_dir: Directory to save screenshot (default: output/validation). view_index: Index of the view to screenshot (default: 0). view_name: Name of the view to screenshot (overrides view_index). env_path: Optional path to a .env file with Tableau credentials. Explicit env_path takes priority over process environment variables.

Returns: {success, path, view_name, view_id, size_kb, error}

Create a new workbook from a TWB or TWBX template file.

Open an existing workbook (.twb or .twbx) for in-place worksheet editing.

List all available fields in the current workbook datasource.

List worksheet names in the current workbook.

List dashboards and their worksheet zones in the current workbook.

Add a calculated field to the datasource.

For formula syntax and best practices, read: read_resource('cwtwb://skills/calculation_builder')

Check Tableau function names without mutating the active workbook.

Report calculated-field datatype/role contradictions without mutation.

Preview or explicitly apply selected calculated-field metadata repairs.

Remove a previously added calculated field.

Create a categorical dimension by grouping source-field members.

Create a Tableau set (datasource filter-group) for membership logic.

Use basis_field + top_n to build a top-N set (e.g. Top Central ranked by SUM(Central - Qty)); omit both to create an empty set used as a Set Action target (e.g. Highlighted Manufacturer).

Set geographic lookup context for generated map coordinates.

Assign or clear a field's geographic role.

Set or clear a field's default Tableau display format.

Embed local shape assets and map categorical members to the native palette.

Initialize an existing native filter action's targets with overridable members.

Set the native fiscal year starting month on a date field and dependencies.

Set datasource weekday origin for date-part headers and week calculations.

Create an ordered Tableau drill hierarchy from bare dimension fields.

Add an INDEX() detail table calculation to trigger Tableau densification.

Complete missing dates for discrete exact-date fields; [] disables completion.

Configure visual subtotals and per-dimension subtotal labels.

Add a field-backed reference line to a configured worksheet pane.

Map ordered categorical tuples to colors, including Measure Names.

Add a constant or field-backed native filled band on an existing axis.

Add a native percentage distribution band on an existing axis.

Add a parameter to the workbook.

Add a new blank worksheet to the workbook.

Clone an existing worksheet and its worksheet window.

Preview worksheet-scoped field rewrites without mutating the workbook.

Rewrite one worksheet to use replacement fields without touching others.

Set or clear a plain-text worksheet caption.

Set or clear the visible plain-text worksheet title.

Hide or unhide a worksheet tab by updating worksheet window metadata.

Configure chart type and field mappings for a worksheet.

For chart type selection and encoding best practices, read: read_resource('cwtwb://skills/chart_builder')

Configure a dual-axis chart composition.

For dual-axis chart patterns and best practices, read: read_resource('cwtwb://skills/chart_builder')

Build layered panes with encodings, ordered values and native styles.

sort_mode='computed' orders dimension members before table calculations; 'shelf' explicitly selects shelf sorting, and 'auto' retains default routing. table_calc_context gives explicit overrides a local native instance identity, including map calculations whose dimensions live on mark detail shelves.

Apply worksheet-level styling: background color, axis/grid/border visibility.

pane_mark_style accepts mark-labels-range-field as a public field expression and resolves its native qualified reference for min/max labels.

For formatting best practices, read: read_resource('cwtwb://skills/formatting')

Configure a showcase recipe chart through the shared recipe registry.

For recipe chart patterns, read: read_resource('cwtwb://skills/chart_builder')

Configure the workbook datasource to use a local MySQL connection.

Configure the workbook datasource to use a Tableau Server connection.

This edits the workbook datasource connection only. It does not configure Tableau REST API/PAT credentials for validate_workbook_api, upload_workbook, or screenshot_workbook; pass env_path to those validation tools instead.

Configure the workbook datasource to use a local Excel connection.

Configure the workbook datasource to use a local CSV connection.

Configure the workbook datasource to use a local Hyper extract connection.

Create a dashboard combining multiple worksheets.

Recommended workflow for complex dashboards:

1. Call list_worksheets to lock worksheet names

2. Design layout with the user (KPI row, main chart, detail views, filters)

3. Call generate_layout_json to save the layout as a JSON or YAML file

4. Call add_dashboard with layout=<layout_file_path>

Layout options:

• str (file path): Path to JSON or YAML layout file (recommended for complex layouts)

• dict: Custom declarative layout tree passed inline Native set control (mode dropdown or checkdropdown): {"type": "set_control", "field": "Set name", "worksheet": "View", "mode": "dropdown"}

• "auto" (default): Simple vertical fallback — use layout dict or layout file for mixed layouts

• "vertical": All worksheets stacked vertically

• "horizontal": All worksheets side-by-side

• "grid-2x2": 2x2 grid layout

For dashboard design best practices, read: read_resource('cwtwb://skills/dashboard_designer')

Add a native dashboard extension with structured manifest and settings.

Extend a continuous date domain and allow calculations on added periods.

Add a filter, highlight, URL, navigation, or parameter dashboard action.

For action_type="parameter", provide source_field, target_parameter, and a Tableau-serialized clear_value such as d:2026-02-12, i:0, or s:LROOT:All.

Add a Set Action (edit-group-action) to a dashboard.

The set fills with the marks under the pointer and clears when it leaves, enabling hover-driven labels and calculations.

Save the active workbook as a .twb or .twbx file. Use a .twbx extension to produce a packaged workbook (ZIP) that bundles the XML with any data extracts and images carried over from the source .twbx.

This is the only default MCP tool that writes the active in-memory workbook to disk. After create_workbook/open_workbook plus worksheet/chart/dashboard edits, call save_workbook with the desired output_path to create the final .twb or .twbx file. validate_workbook and analyze_twb do not save files.

List packaged Gallery layouts and their explicit worksheet slots.

Recommend compatible Gallery templates with scores and reasons.

Bind exact worksheet names to a Gallery template and validate the layout DSL.

Generate and save a dashboard layout file.

Recommended workflow:

1. Call list_worksheets to get available worksheet names

2. Design the layout with the user (show ASCII preview for confirmation)

3. Call this tool to save the layout as a JSON or YAML file

4. Call add_dashboard with layout=<this_file_path>

The layout_tree uses the declarative container DSL:

• {"type": "container", "direction": "vertical"|"horizontal", "children": [...]}

• {"type": "worksheet", "name": "<worksheet_name>"}

• Use "fixed_size" (int, pixels) for KPI rows and filter sidebars

• Use "weight" (int, relative) for main analytical areas

Generate and save a dashboard layout YAML file.

Recommended workflow:

1. Call list_worksheets to get available worksheet names

2. Design the layout with the user (show ASCII preview for confirmation)

3. Call this tool to save the layout as a YAML file

4. Call add_dashboard with layout=<this_file_path>

The layout_tree uses the same declarative container DSL as generate_layout_json.

Convert TWB, TWBX, YAML or JSON by output suffix without an editor session.

YAML/JSON contain an editable native XML tree, not a simplified chart DSL. Assets are copied alongside definitions; keep these files together. Unknown XML is retained. Only XML syntax is checked, not Tableau runtime behavior. The current editor session is not modified. Existing output requires force.

Inspect the first-sheet schema of a target Excel datasource.

Profile workbook datasources and worksheet scope before migration.

Scan source and target schema and propose a field mapping.

Preview a workbook migration onto a target datasource.

Apply a workbook migration and write a migrated TWB plus reports.

List cwtwb's declared capability boundary.

This reports what workbook features/charts are supported by cwtwb. It does not enumerate callable MCP tools and should not be used to infer whether a tool like add_dashboard or save_workbook exists.

Describe one declared capability and its support tier.

Analyze an existing TWB/TWBX file against cwtwb's declared capabilities.

This tool requires a file_path that already exists on disk. It cannot analyze the active in-memory workbook directly and it does not save the current workbook. For a newly generated workbook, call save_workbook first, then pass that saved path to analyze_twb.

Summarize the non-core capability gap of a TWB template.

Validate a workbook against the official Tableau TWB XSD schema.

Checks whether the generated XML conforms to Tableau's published schema. This tool does not save or export the active workbook. If file_path is omitted, it validates the current in-memory workbook before save; if file_path is provided, it validates an existing .twb/.twbx file on disk. Call save_workbook when you need to write the workbook to a file.

Args: file_path: Path to a .twb or .twbx file to validate. If omitted, validates the currently open workbook (in memory, before save).

Returns: PASS/FAIL summary with error details.

Preview how an Excel workbook will be interpreted before connection setup.

Link matching categorical filters so one control filters all given sheets.

Add and activate another independent extracted data source.

Select the source for subsequent field and worksheet authoring.

Define a primary aggregate proxy for a secondary source field.

Link independently aggregated sources in a worksheet without a join.

Union existing native sets at the same dimension grain.

Alias actual Measure Names members, including table calculation measures.

Derive a scrolling Phone layout from the default dashboard objects.

Preserve default geometry in a custom Phone/Tablet layout with shared IDs.

Set rich literal/field mark labels while preserving pane calculation context.

Set formatted text/field runs or embedded sheets with explicit filter_fields.

Show/hide a dedicated dashboard sheet container with a native button.