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.

Instructions

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
sourcePathNo
documentYesPersisted WorkPaper JSON document.
serializedBytesYes
Behavior4/5

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

Annotations already declare readOnlyHint, destructiveHint, idempotentHint. The description adds context that export outputs a JSON document and does not write files to disk, which is useful beyond annotations. However, it does not detail other behavioral aspects like format or limits.

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?

Two sentences: first clearly states action and purpose, second adds an important constraint. No extraneous information. Highly efficient.

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?

Given the simple, one-parameter tool, the description is complete. The presence of an output schema covers return value details. No missing information for effective use.

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 single parameter (includeConfig) has a clear schema description. The tool description does not add further meaning to the parameter beyond what the schema provides. With 100% schema coverage, the baseline is 3.

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 clearly states the verb 'export' and the resource 'WorkPaper JSON document', with explicit purposes (persistence, review, handoff). It is distinct from sibling tools which operate on individual cells or sheets.

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 explains when to use this tool (export for persistence, review, or handoff) and adds a key constraint ('does not write files by itself'). It does not explicitly mention when not to use or provide alternatives, but the context is clear.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/proompteng/bilig'

If you have feedback or need assistance with the MCP directory API, please join our Discord server