Skip to main content
Glama
Payware MCP Server

Payware MCP Server

Official
by payware

payware_products_update_product

DestructiveIdempotent

Updates an existing Payware product by ID, reading it first and sending the full record so selected fields change while omitted fields remain intact.

Instructions

[Merchant] Update an existing product. Only provide the fields you want to change. The tool reads the product first and sends it whole: the server resets a field a partial update leaves out (active, shippable and quickPay to FALSE, type, time zone and time to live to defaults), a server defect.

Product Structure: šŸ“¦ PRODUCT METADATA: name, shortDescription, longDescription, sku, upc, shippable, active, shop šŸ’° PRODUCT DATA (prData object): type, regularPrice, currency, overlapPriority, timeToLive, activeFrom, activeTo, timeZone āš™ļø PRODUCT OPTIONS (prOptions object): imageUrl, termsUrl, termsText

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": {
      "productId": "<productId>"
    },
    "name": "payware_products_update_product"
  }
}

Input Schema

NameRequiredDescriptionDefault
skuNoStock Keeping Unit (SKU)
upcNoUniversal Product Code (UPC)
nameNoProduct recognizable name
shopNoShop code
activeNoIndicates if product can serve as payment source
activeToNoProduct active state ending date (YYYY-MM-DD format)
currencyNoPrice currency (3-character ISO code)
imageUrlNoURL pointing to external product image resource
termsUrlNoURL pointing to external terms and conditions resource
timeZoneNoProduct state scheduling timezone (IANA format, e.g., 'Europe/Sofia')
partnerIdNoMerchant partner ID (uses PAYWARE_PARTNER_ID env var as default)partner_12345
productIdYesProduct identifier to update (starts with 'pr')
shippableNoIndicates if product requires delivery address
termsTextNoTerms and conditions text
activeFromNoProduct active state starting date (YYYY-MM-DD format)
privateKeyNoRSA private key for authentication (uses environment-specific private key as default)
timeToLiveNoTime allowed for product payment in seconds (60-2592000)
useSandboxNoUse sandbox environment
productTypeNoType of product
regularPriceNoProduct regular price as a decimal string. Zero or positive, at most 12 integer digits, and no more decimals than the currency's minor unit (0 for JPY, 2 for EUR, 3 for KWD, 8 for BTC). Returned as a string too.
longDescriptionNoLong product description
overlapPriorityNoPriority when overlapping price schedules exist
shortDescriptionNoShort product description

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.2.0

TDQS

A4/5.0
Behavior5/5

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

Discloses behavior beyond the annotations: the tool reads the product and re-sends it whole, and the server resets omitted fields (active, shippable, quickPay to FALSE; type, timeZone, timeToLive to defaults), explicitly flagging this as a server defect. This is exactly the destructive semantics an agent needs before calling a tool marked destructiveHint=true/idempotentHint=true.

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?

The destructive field-reset warning is front-loaded where it matters most, and the structured field grouping is scannable. The emoji-labeled sections are slightly decorative but each sentence carries information about behavior or structure, so waste is minimal.

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 23-parameter destructive mutation with no output schema, the description covers the two things hardest to discover: the read-modify-whole-write behavior and the field grouping. It omits any indication of what the call returns or how partial-update failures surface, a minor gap given the tool's complexity.

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, but the description adds value by grouping the 23 flat parameters into the API's real shape: product metadata, a prData object (price/currency/scheduling), and a prOptions object (URLs and terms). That mapping is not visible in the schema and helps the agent understand which fields travel together. It does not add formats or constraints beyond what the schema already states.

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?

Opens with a specific verb+resource: "[Merchant] Update an existing product." An agent can tell this apart from the create/delete/get siblings by name alone. It stops short of explicitly contrasting with a sibling tool, so it is clear but not maximally differentiating.

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?

Gives one real usage rule ("Only provide the fields you want to change"), but that rule is immediately undercut by the warning that the server resets omitted fields, leaving the agent to infer that the whole object effectively must be sent. No mention of alternatives such as reading the product first with payware_products_get_product, and no prerequisites around auth or sandbox selection.

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