Skip to main content
Glama
Pirate Ship MCP Server

Pirate Ship MCP Server

Export report

export_report
Read-onlyIdempotent

Generates a CSV of transactions, refunds, receipts, return labels, or carrier adjustments for an optional date range and search, returning a download link when rows match.

Instructions

A CSV of the transactions, refunds, receipts, return labels or carrier adjustments report.

Builds the same spreadsheet as the Export button of the chosen Reports table, with every column of the matching list_ tool, for an optional date range and search. Returns a link to the CSV; no matching rows return empty true and no link. Shipments have their own tool, export_shipments.

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": {
      "report": "<report>"
    },
    "name": "export_report"
  }
}

Input Schema

NameRequiredDescriptionDefault
sortNoOrder by date.newest
reportYes
searchNoFree text, as in the report's search box.
to_dateNoLast day, YYYY-MM-DD, included.
from_dateNoFirst day, YYYY-MM-DD, in your timezone.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv1.0.4
    • addedInput schema / properties / sort / description
      Added value: +"Order by date."
  2. First observedv0.1.0

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, non-destructive, open-world, so the safety profile is covered. The description adds genuinely non-obvious behavior beyond that: it returns a link rather than rows, and a no-match query yields empty=true with no link. No mention of row caps, permissions for restricted reports, or link expiry, keeping it at 4.

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?

Three tight sentences with no filler, and the return-shape/empty-case detail is stated up front where it matters. The opening sentence is a noun fragment rather than a verb phrase, which slightly weakens front-loading, but size is well matched to the tool.

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?

With no output schema, the description correctly compensates by explaining the returned link and the empty-result case, and it enumerates the report choices. Adequate for a 5-parameter read tool, though it omits sort behavior and any guidance on export size limits versus the list_ siblings.

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?

At 80% schema coverage the schema already documents sort, search, from_date and to_date (including timezone and inclusive-end semantics). The description adds little beyond noting the date range and search are optional and that they mirror the report UI's search box. It never mentions sort, which is the one parameter the schema describes only minimally ("Order by date").

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?

Names the concrete artifact produced (a CSV of one of five report types) and anchors it to a known UI action ("same spreadsheet as the Export button"), so the agent knows exactly what will come back. It also explicitly separates itself from export_shipments, which is the closest sibling.

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?

Explicitly routes shipments to export_shipments, and by saying the export has "every column of the matching list_ tool" it implicitly frames the export-vs-list choice. It stops short of stating when to prefer the CSV export over list_transactions/list_refunds/etc. (e.g., bulk/beyond-pagination needs).

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