Skip to main content
Glama

Report document

get_report_document
Read-only

Download and parse an SP-API report document into rows/columns. GZIP-compressed and uncompressed documents are supported; ZIP and restricted report types are not supported. Given a reportDocumentId (from create_report or get_report), returns the report payload as structured rows. Returns the report's facts as-is and never recommends actions.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
formatNoPayload parse format. 'auto' (default) tries JSON first and falls back to TSV; 'json' parses a JSON array/object of rows; 'tsv' parses a tab-separated table with a header row.auto
max_rowsNoMaximum number of rows to parse and return (1-5000, default 500). Reports larger than this are truncated; pass a higher value for the full table up to the cap.
array_keyNoFor JSON reports whose rows are wrapped under a key (e.g. dataByAsin, salesAndTrafficByAsin), the key to unwrap. Ignored for TSV.
report_typeNoOptional SP-API report type (e.g. GET_SALES_AND_TRAFFIC_REPORT). Used for diagnostics and to hint at the payload format. Restricted report types that require a restricted data token are not supported.
report_document_idYesThe reportDocumentId returned by create_report or get_report (SP-API Reports API).

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
evidenceNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already cover the safety profile (readOnlyHint, destructiveHint=false, openWorldHint=true), and the description adds useful constraints beyond them: GZIP supported, ZIP/restricted unsupported, and the 'facts as-is, never recommends actions' framing. Truncation behavior is delegated to the schema's max_rows, so it is not restated here.

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?

Four tight sentences, front-loaded with the action and result shape, then constraints, then the parameter source and behavioral caveat. No filler, though the final 'never recommends actions' clause is slightly tangential.

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, relieving the description of return-value duty, and annotations carry the safety profile. The description still covers the notable unsupported-format cases and input provenance, leaving little an agent would need missing.

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 100%, so the parameter baselines sit at 3. The description adds document-format constraints (GZIP/ZIP) but says nothing about format, max_rows, or array_key semantics beyond what the schema already documents.

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 ('Download and parse') plus resource ('SP-API report document') and the output shape ('into rows/columns'). The reportDocumentId provenance (create_report or get_report) further anchors it against the many other 'get_*' 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?

Explains the prerequisite clearly ('Given a reportDocumentId (from create_report or get_report)') and gives explicit exclusions ('ZIP and restricted report types are not supported'), which is real when-not guidance. It stops short of naming a sibling alternative for the unsupported cases, so it is not quite a 5.

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.