Skip to main content
Glama
Payware MCP Server

Payware MCP Server

Official
by payware

payware_products_create_product

Creates a new product for inventory management and payment processing, with details such as name, price, SKU, and active status.

Instructions

[Merchant] Create a new product for inventory management and payment processing.

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

Required: name Optional: All other parameters have sensible defaults

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

Input Schema

NameRequiredDescriptionDefault
skuNoStock Keeping Unit (SKU)
upcNoUniversal Product Code (UPC)
nameYesProduct recognizable name (required)
shopNoShop code (if not supplied, default shop is used)
activeNoIndicates if product can serve as payment sourceFALSE
activeToNoProduct active state ending date (YYYY-MM-DD format)
currencyNoPrice currency (3-character ISO code)EUR
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')GMT
partnerIdNoMerchant partner ID (uses PAYWARE_PARTNER_ID env var as default)partner_12345
shippableNoIndicates if product requires delivery addressFALSE
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 productITEM
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.0.00
longDescriptionNoLong product description
overlapPriorityNoPriority when overlapping price schedules existLOWEST
shortDescriptionNoShort product description

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.2.0

TDQS

B3.1/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=false, destructiveHint=false, openWorldHint=true and non-idempotent, so the mutation profile is covered. The description adds the defaults posture ("All other parameters have sensible defaults"), which is useful, but says nothing about duplicates (e.g. repeated SKU), sandbox vs production effects, or what a successful creation returns.

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

Conciseness3/5

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

The opening sentence is front-loaded and correct, but the emoji-headed parameter catalogue is largely decorative formatting that duplicates the schema, and several parameters (timeToLive, useSandbox, partnerId, privateKey, activeFrom/activeTo) are missing from the supposedly exhaustive listing, so the structure promises more completeness than it delivers.

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?

For a 22-parameter creation tool with no output schema, the definition covers required vs optional and defaults, but omits what the tool returns (a product identifier?), how sandbox interacts with real inventory, and any failure modes. The auth-related parameters are documented in the schema, which keeps this from being a larger gap.

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 description coverage is 100%, so the schema already documents all 22 parameters in detail; baseline 3 applies. The description's grouping into PRODUCT METADATA / PRODUCT DATA (prData) / PRODUCT OPTIONS (prOptions) adds some structural context beyond the flat schema, but it also renames fields loosely ("type" vs productType) and omits auth/environment params entirely.

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?

States a specific verb and resource ("Create a new product") with the domain scope ("inventory management and payment processing"), which is enough to separate it from the get/list/update/delete siblings by name alone. It stops short of naming and contrasting an alternative explicitly, so it is clear but not maximally differentiated.

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

Usage Guidelines2/5

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

There is no statement of when to use this tool versus e.g. payware_products_update_product or payware_products_create_placement, nor any prerequisites (the merchant/partner auth flow implied by partnerId and privateKey is never mentioned). Only the required/optional split is given, which is a schema restatement rather than usage guidance.

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