Skip to main content
Glama

Export a tool document

tools_export_document
Read-only

Export a document as a file. format "json" (the default) returns the snapshot the builder's Download JSON writes: the saved state, which the Scenarios Upload button imports as a new document, a summary, and the canonical entities (outcomes, with their kind, metrics, and bets) in one vocabulary across tools. format "markdown" returns the document as markdown.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "documentId": "<documentId>"
    },
    "name": "tools_export_document"
  }
}

Input Schema

NameRequiredDescriptionDefault
formatNojson (default) or markdown.
documentIdYesThe document id, from tools_list_documents.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false and openWorldHint=false, so safety is covered. The description adds real value by enumerating the json payload contents (saved state, summary, canonical entities) and how that payload is re-imported via the Scenarios Upload button. However, for a read with no output schema it never says what the tool actually returns to the agent — file bytes, a download URL, or inline text — which is the single most important unknown for an export tool.

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

Conciseness3/5

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

Purpose is front-loaded in the first short clause, which is good. The remainder is one long compound sentence dense with product-UI jargon ("builder's Download JSON", "Scenarios Upload button", "one vocabulary across tools") whose clauses are hard to parse and partly editorialize about the platform rather than describe the tool.

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

Completeness3/5

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

With only two well-documented parameters and full annotation coverage, the definition covers most of what a caller needs on the input side. Because there is no output schema, the description has to carry the return-value burden, and it leaves the artifact's form (file handle vs. bytes vs. URL) unspecified, which is a material completeness gap for an export operation.

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 100%, so baseline is 3, and the description clears that bar by adding meaning beyond the schema's bare "json (default) or markdown": it specifies that json mirrors the builder's Download JSON snapshot and is importable as a new document, and that markdown yields a markdown rendering. documentId is not discussed beyond the schema, but the schema already points at tools_list_documents.

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

Purpose4/5

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

Opens with a specific verb and resource ("Export a document as a file") and then explains what each output format produces, which is genuinely distinguishing detail. It never names a sibling from the list (e.g. tools_get_document) as the alternative for in-app reading, so the agent must infer the boundary.

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

Usage Guidelines3/5

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

Guidance is indirect: the format descriptions imply when json is wanted (round-trippable snapshot for re-upload) versus markdown (human-readable text). There is no explicit statement of when to export at all versus using tools_get_document, and no prerequisites or limits are given.

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.

Resources