Skip to main content
Glama

Simulate a test payment

simulate_test_payment
Idempotent

Move a test payment to scanned, paid, expired, or failed to trigger matching webhook events and test payment flows, including late-payment scenarios.

Instructions

Moves a test payment to scanned, paid, expired or failed, as if the customer and the bank had acted, and the store's test webhook endpoints get the matching event. Test payments only. To try a late payment, simulate expired and then paid. A status the payment can't move to changes nothing.

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": {
      "id": "<id>",
      "status": "<status>"
    },
    "name": "simulate_test_payment"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYesThe test payment's id.
statusYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare non-read-only, open-world, idempotent and non-destructive. The description adds the key side effect the annotations cannot express: the store's test webhook endpoints receive the matching event. It also discloses no-op semantics ('A status the payment can't move to changes nothing'), which is important given idempotentHint and prevents the agent from treating a failed transition as an error.

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?

Four short sentences, each carrying distinct information: effect, scope restriction, sequencing recipe, and no-op rule. The behavioral fact (moves the payment state) is front-loaded before the caveats.

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?

With only two parameters, no output schema, and full annotation coverage, the description supplies what an agent needs: what changes in this system, what fires externally, what is a no-op, and the 'test only' boundary. The main omission is that it never states which transitions are actually permitted, so the agent must discover invalid moves by trial.

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 50%: id is documented in the schema while status relies on its enum. The description restates the same four status values and adds the useful notion of a constrained state machine ('a status the payment can't move to changes nothing'), but it does not explain what each status means or which transitions are legal, which is the real semantic gap for this parameter.

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?

The description names a specific verb ('Moves') and resource ('a test payment') and enumerates the four reachable states. It also makes the crucial distinction that this simulates an external actor's action rather than creating a payment, which cleanly separates it from create_test_payment and get_payment.

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?

It gives an explicit exclusion ('Test payments only') and a concrete sequencing recipe for a common scenario ('To try a late payment, simulate expired and then paid'). It does not name sibling alternatives, but the 'test payments only' boundary plus the worked example gives the agent enough to select it correctly.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.