Skip to main content
Glama
Sign In
Payware MCP Server

Payware MCP Server

Official
by payware
OverviewSchemaSourceRelated ServersDiscussionsAdmin
JavaScript
Remote

payware_data_get_export_list

Read-onlyIdempotent

Retrieve all export attempts for a report request, including available formats, status, and download details. Use it to track production export progress and locate generated report files.

Instructions

[Merchant] Get all export attempts for a specific report request. Returns list of exports in various formats with their status and download information. Production only - not supported in sandbox.

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": {
      "requestId": "<requestId>"
    },
    "name": "payware_data_get_export_list"
  }
}

Input Schema

NameRequiredDescriptionDefault
partnerIdNoPartner ID from payware dashboard. Uses PAYWARE_PARTNER_ID env var as default.partner_12345
requestIdYesThe request ID (UUID) to get exports for
privateKeyNoRSA private key for authentication. Uses production private key as default (Data API is production-only).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.2.0

TDQS

A3.7/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, and destructiveHint=false, so the safety profile is covered. The description adds genuinely new context beyond that: "Production only - not supported in sandbox," which an agent cannot infer from structured fields, plus a note that the payload carries status and download information. It does not mention pagination, ordering, or result caps for a list operation.

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: scope tag, core action, return shape, then the environment constraint. Nothing is wasted and the action is front-loaded. The "[Merchant]" prefix is terse but does add scope context.

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 read-only list tool with full schema coverage and no output schema, the description covers what it returns (formats, status, download info) and its key environmental limitation. The remaining gap is list-shape behavior such as pagination or empty-result semantics, which is minor for this tool's complexity.

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 requestId, partnerId, and privateKey are already fully documented, including defaults from environment variables. The description reinforces that requestId identifies a "report request" but adds no format, uniqueness, or error-condition detail beyond the schema, so the baseline of 3 applies.

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?

"Get all export attempts for a specific report request" states a specific verb and resource, and the plural "all export attempts" plus "with their status and download information" separates it from the singular get_export_status, cancel_export, and download_export siblings. It does not name those siblings explicitly, so differentiation is inferred rather than declared.

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?

Usage is strongly implied: call this after exporting a report to enumerate every export attempt for that requestId. However, there is no explicit when-to-use or when-not-to-use statement, and no named alternative for fetching a single export's status versus the full attempt list.

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