Skip to main content
Glama
Sign In
Payware MCP Server

Payware MCP Server

Official
by payware
OverviewSchemaSourceRelated ServersDiscussionsAdmin
JavaScript
Remote

payware_data_get_export_status

Read-onlyIdempotent

Check the status of a Payware report export request by export ID to monitor progress and determine when the export is ready.

Instructions

[Merchant] Get the status of a report export request. Use this to monitor export progress.

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_get_export_status"
  }
}

Input Schema

NameRequiredDescriptionDefault
exportIdYesThe export ID returned 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 environment-specific private key as default.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.2.0

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare readOnly, idempotent, non-destructive, and open-world, so the safety profile is covered. The description adds only the monitoring intent and says nothing about what status values are returned or whether polling should be throttled, which matters for a status-check tool.

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?

Two short sentences with the resource and action front-loaded and zero filler. Slightly redundant but efficient.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

No output schema exists, so the description carries the burden of describing return values, yet it never indicates what statuses (pending/complete/failed) or fields an agent should expect. Adequate for routing, thin for interpreting results.

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 exportId's UUID format and the partnerId/privateKey defaults are fully documented in the schema. The description adds no extra meaning about how exportId relates to the export request call.

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?

Names a specific verb and resource: "Get the status of a report export request." An agent can distinguish it from export_list or download_export by the word "status," though no sibling is named explicitly.

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?

"Use this to monitor export progress" implies the polling-after-export workflow, but gives no explicit prerequisites (e.g., must call export_report first) or exclusions against sibling status/list tools.

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