Skip to main content
Glama

Export Report Review Envelope

export_report_review_envelope
Read-onlyIdempotent

Export one verified frozen review record as versioned JSON or CSV, accessible HTML or optional tagged PDF. Returns exact bytes as UTF-8 or PDF base64 with SHA-256. PDF dependency or glyph failures offer HTML fallback. No delivery, share or approval is created. Requires tickets:read.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
formatNo
envelope_idYes

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 already cover safety (readOnly, idempotent, non-destructive), and the description adds genuine behavioral context beyond them: exact byte return (UTF-8 or PDF base64), SHA-256 checksum, the HTML fallback on PDF dependency/glyph failure, and the auth requirement. That is a rich disclosure of return shape and failure handling with no output schema present.

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?

Telegraphic but efficient; the output format and effect are front-loaded. Every sentence contributes substance (formats, return encoding, fallback, side-effect disclaimer, auth), with no filler.

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?

For a 2-parameter export tool with no output schema, the description adequately covers returns, encoding, fallback and permissions. Only the exact semantics of envelope_id selection and any size/rate limits remain unstated.

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 coverage is 0%, so the description must carry parameter meaning. It documents the format values (json/csv/html/pdf) matching the enum and clarifies that envelope_id names 'one verified frozen review record', but adds no detail on id origin, constraints, or format-default behavior. Marginal compensation for the coverage gap.

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 (export) plus resource (one verified frozen review record) and enumerates the output formats. An agent can distinguish it from get_report_review_envelope, list_report_review_envelopes and export_portfolio_snapshot from the description alone.

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?

Implies usage via the delivery caveat ('No delivery, share or approval is created') and the prerequisite ('Requires tickets:read'), which frames it as a byte-producing read. However it never names a sibling alternative or an explicit when-to-use versus get_report_review_envelope, so routing is left to inference.

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