Skip to main content
Glama

save_workbook

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.

Instructions

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.

Input Schema

NameRequiredDescriptionDefault
output_pathYes

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 are provided, so the description carries the full burden. It discloses the write-to-disk behavior, the packaging semantics of .twbx (ZIP bundling XML, extracts, images), and that it is the sole file-writing tool. It does not address overwrite behavior, required permissions, or error conditions for an existing output_path, leaving a real gap for a mutation tool.

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-loaded with the core action and format choice, then usage context. Slightly repetitive in restating 'create the final .twb or .twbx file' after the opening sentence already covered the formats, but overall tight and well-ordered.

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?

An output schema exists, so return values need not be explained. The description covers usage sequencing, format semantics, and sibling disambiguation, which is nearly everything an agent needs. The remaining gap is overwrite/error behavior, which matters for a file-writing tool with no annotations.

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 output_path parameter has no schema description, so the description must compensate. It does explain that the file extension drives output format (.twb vs packaged .twbx), which is meaningful parameter semantics, though it doesn't clarify path expectations (absolute vs relative, directory creation).

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+resource ('Save the active workbook') and specifies the output formats (.twb/.twbx). It explicitly differentiates itself from siblings by claiming to be 'the only default MCP tool that writes the active in-memory workbook to disk,' which an agent can distinguish from upload_workbook, convert_workbook, validate_workbook, and analyze_twb.

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?

Gives explicit sequencing ('After create_workbook/open_workbook plus worksheet/chart/dashboard edits, call save_workbook with the desired output_path') and names non-alternatives ('validate_workbook and analyze_twb do not save files'). The when-to-use condition and the disambiguation from lookalike siblings are both present.

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