Skip to main content
Glama

Export validation research document

validation.export_document
Idempotent

Export all saved sections together as pdf or md using the editor's renderer. Creates a private generated file and returns its short-lived HTTPS download reference and expiry; md also returns readable Markdown. This does not publish or share research. Requires validation.read and a stable idempotency key. Download before expiry; request a fresh export after expiry.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
formatNomd
project_idYes
idempotency_keyNo
validation_project_idYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.1/5.0
Behavior5/5

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

Annotations only declare readOnly=false, idempotent=true, destructive=false. The description goes well beyond this: it discloses that a private generated file is created, that the return is a short-lived HTTPS download reference plus expiry, that md additionally returns readable Markdown, that the operation does not publish or share, and that it requires validation.read and an idempotency key.

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, then behavior, safety scope, requirements, and expiry handling. Every sentence carries information; only slight compression of the file/return details would tighten it further.

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 fully explained, yet the description still usefully covers the download reference, expiry, and Markdown output. The one real gap is the unexplained distinction between validation_project_id and project_id, which matters for a 4-parameter tool.

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 the format choice (pdf/md) and the idempotency_key semantics, but leaves the relationship between validation_project_id and project_id (both required, one nullable) completely undocumented in both schema and description.

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?

States a specific verb and resource: "Export all saved sections together as pdf or md using the editor's renderer." This is clearly distinct from sibling tools like validation.save_workspace and validation.regenerate_section, but it does not explicitly name or rule out those siblings.

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?

Gives clear context and an exclusion ("This does not publish or share research"), plus prerequisites ("Requires validation.read and a stable idempotency key") and a lifecycle rule ("Download before expiry; request a fresh export after expiry"). It stops short of naming alternative tools to use instead, so it is not a full when/when-not/alternatives statement.

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