Skip to main content
Glama
Sign In
Payware MCP Server

Payware MCP Server

Official
by payware
OverviewSchemaSourceRelated ServersDiscussionsAdmin
JavaScript
Remote

payware_poi_get_status

Read-onlyIdempotent

Retrieves a POI's current state and latest or session-specific transaction status, enabling merchants to follow a sale to its final outcome and recover from missed callbacks.

Instructions

[Merchant] Get the current status of a POI and the outcome of its sales.

Authentication: your own JWT (an ISV makes the same call on your behalf). Endpoint: GET /poi/{poiId}/status[?sessionToken=...] Use Case: Follow a sale to its outcome - the backup to callbacks, and on Basic (no transaction endpoints) the only way when a callback is lost or there is no backend.

POI States:

  • IDLE: no pending price and no sale running

  • READY: price set, waiting for a scan (wins over BUSY: the POI can take the next price while a sale runs)

  • BUSY: a customer scanned and the sale is running

Every response carries lastTransactionId / lastTransactionStatus - the POI's most recent sale, running (ACTIVE) or finished (CONFIRMED, DECLINED, FAILED, CANCELLED, EXPIRED). Once the POI is back to IDLE, lastTransactionStatus is how the last sale ended.

With sessionToken (from payware_poi_set_price) the response also carries transactionId / transactionStatus for exactly that sale - use it when the POI may be re-armed before the previous sale finishes. Poll every 2-3 seconds and stop at a final status; the read is rate limited.

Required: POI ID.

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": {
      "poiId": "<poiId>"
    },
    "name": "payware_poi_get_status"
  }
}

Input Schema

NameRequiredDescriptionDefault
poiIdYesThe POI identifier (format: pi + 8 alphanumeric chars, e.g., piABC12345)
useSandboxNoUse sandbox environment for testing
sessionTokenNoOptional. The sessionToken returned by payware_poi_set_price; returns that sale's transaction and status

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.2.0

TDQS

A4.6/5.0
Behavior4/5

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

Goes well beyond the annotations (readOnlyHint, idempotentHint) by disclosing rate limiting, recommended poll interval, and termination conditions. It also documents the authentication model (own JWT, ISV acting on your behalf) and the exact endpoint. The one small gap is that the sandbox parameter's behavioral implications are not discussed, but the safety profile is already covered by annotations.

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?

Front-loaded purpose sentence, then labeled sections for authentication, endpoint, use case, POI states, and response contents. Structure is clear and most content earns its place, though the trailing 'Required: POI ID' restates the schema and the state list is verbose relative to what an agent strictly needs.

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

Completeness5/5

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

There is no output schema, and the description fully compensates by enumerating the returned fields (lastTransactionId, lastTransactionStatus, plus per-session transactionId/transactionStatus) and their terminal values. Authentication, endpoint, polling behavior, and state semantics are all present, leaving nothing an agent needs to call it correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the baseline is 3; the description earns slightly more by explaining the situational reason to pass sessionToken (the POI may be re-armed before the previous sale finishes), which the schema does not convey. It does not mention useSandbox at all, and much of the sessionToken text duplicates the schema.

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?

States a specific verb and resource (get the current status of a POI) plus a second output dimension (outcome of its sales). The scope is precise enough to separate it from payware_poi_get, which returns POI configuration rather than live state and sale outcomes.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicitly names when to use it: following a sale to its outcome, as a backup to callbacks, and the only option on Basic plans without transaction endpoints or a backend. It also gives the polling cadence (every 2-3 seconds, stop at a final status) and the condition that selects the sessionToken path.

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