Skip to main content
Glama

validate_workbook

Validate a workbook against the official Tableau TWB XSD schema.

Instructions

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.

Input Schema

NameRequiredDescriptionDefault
file_pathNo

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.18.1

TDQS

A4.5/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations, so description must carry the burden. It discloses key behavioral traits: no side effects (does not save/export), what gets validated (generated XML vs published schema), and both validation modes. Does not cover performance or output details, but the output schema exists.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loads purpose, follows with mode selection and the save_workbook cross-reference. The Args/Returns block is slightly verbose given the output schema exists, but overall efficient and well-organized.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Covers purpose, the two validation modes, side-effect absence, and parameter semantics. Output schema exists so return explanation is unnecessary. Adequate for a low-complexity single-param tool, though not exhaustive.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 0% and the single parameter is undocumented in the schema, so the description must compensate. It explains the format (.twb/.twbx) and the dual meaning of omission vs. presence. This is a strong compensation for a null-coverage schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States specific verb+resource (validate a workbook) and names the exact schema (Tableau TWB XSD). Distinguishes itself from siblings by clarifying it does not save or export, explicitly deferring to save_workbook.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicitly covers the when: omitted file_path validates the in-memory workbook before save, provided file_path validates a disk file. Names save_workbook as the alternative for writing, satisfying the alternatives requirement.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools