Skip to main content
Glama
Sign In
Payware MCP Server

Payware MCP Server

Official
by payware
OverviewSchemaSourceRelated ServersDiscussionsAdmin
JavaScript
Remote

payware_data_list_reports

Read-onlyIdempotent

Lists available production report types with configurations, descriptions, and visibility settings so merchants can identify reporting options.

Instructions

[Merchant] List all available report types with their configurations, descriptions, and visibility settings. Production only - not supported in sandbox.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "payware_data_list_reports"
  }
}

Input Schema

NameRequiredDescriptionDefault
partnerIdNoPartner ID from payware dashboard. Uses PAYWARE_PARTNER_ID env var as default.partner_12345
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

A4/5.0
Behavior4/5

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

Annotations already declare read-only, idempotent, non-destructive, open-world behavior, so the safety profile is covered. The description adds value beyond them by disclosing the environment limitation (no sandbox) and sketching the shape of the returned data (configurations, descriptions, visibility settings).

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two compact sentences: the capability first, then the critical environment caveat. Nothing is redundant or padded.

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 two-parameter read-only listing tool with no output schema, the description supplies the key constraint (production-only) and enumerates what the response contains, which substitutes for a missing return schema. Only the choice among sibling listing tools is left unexplained.

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% and both parameters (partnerId, privateKey) are documented in the schema, including env-var defaults. The description adds only the corroborating note that production credentials apply, so the baseline of 3 is appropriate.

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: list all available report types, including configurations, descriptions, and visibility settings. This is clearly distinct from the actual generation/export siblings (generate_report, export_report) without needing to name them, though no sibling is explicitly referenced.

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?

The 'Production only - not supported in sandbox' clause gives a concrete environment constraint that prevents misuse. It does not, however, say when to prefer this over adjacent discovery tools like get_report_requests or get_export_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