Skip to main content
Glama

convert_workbook

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

Instructions

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.

Input Schema

NameRequiredDescriptionDefault
forceNo
input_pathYes
output_pathYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.28.0

TDQS

A4.2/5.0
Behavior4/5

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

No annotations are provided, so the description carries the full burden. It discloses that YAML/JSON contain an editable native XML tree, assets are copied alongside definitions, unknown XML is retained, only XML syntax is checked, the current editor session is not modified, and existing output requires force. It omits permission requirements and error behavior, but covers important behavioral traits.

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

Conciseness5/5

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

Front-loads the core purpose, then adds necessary behavioral caveats in compact sentences. No redundant or filler content; every sentence adds value for a tool with no annotations.

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?

Given no annotations and no output schema, the description is fairly complete on behavior and caveats. It does not describe return values or error handling, which would be useful in the absence of an output schema.

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

Parameters3/5

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

Schema description coverage is 0%, so the description must compensate. It explains that output format is determined by output suffix (output_path) and that force is needed to overwrite existing output, but leaves input_path and exact path/format semantics undocumented.

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 a specific verb (convert), resources (TWB, TWBX, YAML, JSON), and key constraints (by output suffix, without an editor session). This distinguishes it from siblings like open_workbook or save_workbook that operate within an editor session.

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

Usage Guidelines4/5

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

Provides clear context: use when converting between formats without an editor session, and notes that existing output requires force. It does not name alternatives or explicitly exclude other tools, but the condition for use is clear.

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