Skip to main content
Glama

Export WorkPaper Document

export_workpaper_document
Read-onlyIdempotent

Export the current WorkPaper JSON document for persistence, review, or handoff to another agent. Does not write files by itself.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
includeConfigNoInclude workbook configuration metadata in the exported JSON. Defaults to true.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
documentYesPersisted WorkPaper JSON document.
sourcePathNo
serializedBytesYes

Schema Changelog

Changes observed during successful MCP inspections. Dates show when Glama detected each change.

  1. First observed

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false. The description adds a crucial behavioral nuance: 'Does not write files by itself', indicating the agent must handle persistence. This goes beyond the annotation hints and prevents a potential misuse.

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?

The description is two sentences long, front-loaded with the primary action, and contains zero redundant content. Every phrase contributes to understanding the tool's purpose and a key behavioral caveat.

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

Completeness5/5

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

For a simple export tool with one optional parameter, an output schema, and strong annotations, the description is complete. It covers the target resource, the use cases, and the non-persistence behavior, leaving no obvious gaps for an agent to invoke it correctly.

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?

The input schema fully describes the only parameter includeConfig with a clear description and default, achieving 100% coverage. The tool description adds no additional parameter semantics, so the baseline score of 3 is appropriate.

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?

The description explicitly states the verb 'Export' and the resource 'current WorkPaper JSON document', clearly distinguishing it from the sibling cell-level operations. The addition of 'for persistence, review, or handoff' further clarifies the tool's role.

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?

The description provides clear context for when to use the tool (obtaining a serialized snapshot for persistence, review, or handoff) and implies it is for the current document. It does not explicitly exclude alternatives, but the sibling tools are so obviously distinct that confusion is unlikely.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

TDQS

A4.3/5.0
Disambiguation4/5

Tools are mostly distinct with clear purposes for reading, writing, exporting, and validating. Slight overlap exists between get_cell_display_value and read_cell, and between the two set_cell variants, but descriptions clarify the intended use.

Naming Consistency5/5

All tool names follow a consistent verb_noun snake_case pattern (e.g., list_sheets, read_cell, validate_formula). This predictable naming makes the set easy to navigate.

Tool Count5/5

With 8 tools, the set is well-scoped for interacting with a WorkPaper document. Each tool serves a clear purpose without unnecessary bloat.

Completeness3/5

Core operations for reading, writing, validating, and exporting are covered, but the surface lacks batch cell writes, cell clearing, and sheet management. These notable gaps may hinder complex editing workflows.