Skip to main content
Glama
Sign In
Payware MCP Server

Payware MCP Server

Official
by payware
OverviewSchemaSourceRelated ServersDiscussionsAdmin
JavaScript
Remote

payware_poi_cancel_price

DestructiveIdempotent

Cancel a pending POI price before payment scan to reset the point of interaction to IDLE and make it ready for a new price.

Instructions

[Merchant] Cancel a pending price on a POI, resetting it to IDLE state.

Authentication: your own JWT (an ISV makes the same call on your behalf). Endpoint: DELETE /poi/{poiId}/price Use Case: Cancel a price that was set but not yet scanned (e.g., order cancelled).

The POI returns to IDLE and is ready for a new price.

Only before the scan. The scan is the customer's bank processing the payment, so from then on a POI sale cannot be cancelled by the merchant or an ISV, on any plan: this answers 409 ERR_POI_NO_PENDING_PAYMENT, and cancelling the transaction itself answers 409 ERR_ALREADY_PROCESSED. The sale completes or expires; the POI accepts the next price meanwhile.

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

Input Schema

NameRequiredDescriptionDefault
poiIdYesThe POI identifier (format: pi + 8 alphanumeric chars, e.g., piABC12345)
useSandboxNoUse sandbox environment for testing

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.2.0

TDQS

A4.6/5.0
Behavior5/5

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

Annotations already flag destructive and openWorld, but the description adds substantial context: authentication model (own JWT or ISV on your behalf), the endpoint, the IDLE state transition, and the precise failure semantics after scan. This is the kind of pre-condition and irreversibility detail an agent needs before invoking a destructive 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?

Bolded section headers make it scannable and the constraint that matters most (only before the scan) is prominent. A couple of lines, notably 'Required: POI ID', duplicate the schema rather than adding information.

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?

With no output schema, the description still explains the post-call state ('The POI returns to IDLE and is ready for a new price') and the error outcomes, which is exactly what an agent needs to reason about the result of a destructive mutation.

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 both poiId and useSandbox are already documented in the schema. The description only restates 'Required: POI ID' without adding format or sandbox-vs-production guidance, so it provides no meaning beyond the structured fields.

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 ('Cancel a pending price on a POI') plus the resulting state ('resetting it to IDLE'). It also implicitly contrasts with payware_poi_set_price by scoping to prices 'set but not yet scanned', so the agent can distinguish it from the sibling that creates prices.

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?

Gives an explicit use case ('e.g., order cancelled') and a hard exclusion boundary ('Only before the scan'), plus routing guidance between two confusable cancel operations, mapping each to its respective 409 error (ERR_POI_NO_PENDING_PAYMENT vs ERR_ALREADY_PROCESSED). Nothing about when to pick this action is left to inference.

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