Skip to main content
Glama
Sign In
Payware MCP Server

Payware MCP Server

Official
by payware
OverviewSchemaSourceRelated ServersDiscussionsAdmin
JavaScript
Remote

payware_data_download_export

Idempotent

Download a ready Payware export by export ID, previewing text formats or saving CSV, HTML, XML, PDF, XLS(X), DOCX, ODT, ODS, or RTF files to the temp downloads folder with saveToFile.

Instructions

[Merchant] Download a READY export file (production only). A text export (CSV, HTML, XML) is previewed; with saveToFile the file is written to payware-mcp-downloads in the system temp directory and the result names its path. A binary export (PDF, XLS(X), DOCX, ODT, ODS, RTF) needs saveToFile.

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": {
      "exportId": "<exportId>"
    },
    "name": "payware_data_download_export"
  }
}

Input Schema

NameRequiredDescriptionDefault
exportIdYesThe export ID from the export request (UUID format)
partnerIdNoPartner ID from payware dashboard. Uses PAYWARE_PARTNER_ID env var as default.partner_12345
privateKeyNoRSA private key for authentication. Uses the production private key as default (reports run on production only).
saveToFileNoSave the file to payware-mcp-downloads in the system temp directory and return its path. Without it a text export is previewed and a binary one only described.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.2.0

TDQS

A3.9/5.0
Behavior4/5

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

Annotations declare readOnlyHint=false, idempotentHint=true and destructiveHint=false, so safety is already covered. The description adds real behavioral value beyond them: only READY exports work, production-only, text exports are previewed while binary exports fail without saveToFile, and files land in a named temp directory whose path is returned. It omits any auth/permission caveats despite the privateKey requirement.

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 compact sentences, front-loaded with the action and the hard precondition, then the text-vs-binary branch. The supported-format lists are slightly noisy but earn their place by telling an agent which calls will fail without saveToFile.

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 does the needed work of describing what comes back: an inline preview for text formats or a path to the written file. The remaining gap is operational context such as export expiry or authentication expectations, which matters for a production-only download.

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 100%, so the description's contribution is judged against a high baseline. It reinforces saveToFile's effect and clarifies that binary formats (PDF, XLS(X), DOCX, ODT, ODS, RTF) require it, but adds nothing about exportId, partnerId or privateKey beyond what the schema already 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?

The description states a specific verb and resource ('Download a READY export file') plus a scope tag ('[Merchant]') and a precondition (production only). The READY qualifier implicitly separates it from payware_data_get_export_status and payware_data_get_export_list, but no sibling is named, so routing still requires inference.

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?

It clearly states prerequisites (the export must be READY, production only) and gives an explicit condition for the main behavioral fork: use saveToFile for binary formats, omit it to preview text. It stops short of naming an alternative tool or explaining what to do when the export is not yet READY.

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

Deploy Server

Other Tools