Skip to main content
Glama

Simulate payment batch

simulate_payment_batch
Read-onlyIdempotent

Validate a payment batch against ISO 20022 schemas and optional scheme rules before XML generation; return totals, control sums, account counts, and duplicate findings.

Instructions

Simulate and pre-flight a payment batch before XML generation.

Performs comprehensive pre-flight verification without generating XML
or staging files:

1. Validates records against the message type's JSON Schema.
2. Validates records against an optional payment-scheme rulebook.
3. Computes control sums grouped by currency.
4. Calculates unique debtor and creditor account counts.
5. Detects intra-batch duplicate transactions (same debtor, creditor,
   amount, currency, and execution date).

Returns a structured verdict with totals, sums by currency, duplicate
findings, and schema/scheme errors.

Args:
    message_type: A supported ISO 20022 pain message type.
    records: One or more flat payment records to simulate.
    scheme: Optional payment scheme profile to validate against.

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": {
      "message_type": "<message_type>",
      "records": "<records>"
    },
    "name": "simulate_payment_batch"
  }
}

Input Schema

NameRequiredDescriptionDefault
schemeNoOptional payment-scheme rulebook profile to enforce, or several joined by commas. One of 'ae-uaefts', 'anti-duplicate', 'cbpr-cross-border', 'ch-domestic', 'ch-sepa', 'de-axz', 'de-ccu', 'hk-fps', 'my-duitnow', 'purpose-mandate-ae', 'purpose-mandate-gb', 'purpose-mandate-hk', 'purpose-mandate-my', 'purpose-mandate-qa', 'qa-qatch', 'se-bankgiro', 'sepa-b2b', 'sepa-inst', 'sepa-sct', 'sepa-sdd', 'sg-fast', 'uk-bacs', 'uk-bacs-dd', 'uk-chaps', 'uk-fps', 'us-ach', 'us-rtp', 'us-wire', 'xborder-ct'. Omit to skip scheme-specific rulebook validation.
recordsYesOne or more flat payment records to simulate and pre-flight before generating XML. One or more flat payment records (dicts of field name → value). Key fields (see get_input_schema for the full contract): id, date (payment-initiation timestamp; 'YYYY-MM-DD' is accepted and rendered as midnight), initiator_name, payment_id, requested_execution_date ('YYYY-MM-DD'), debtor_name, debtor_account_IBAN, debtor_agent_BIC, creditor_name, creditor_account_IBAN, creditor_agent_BIC, payment_amount (alias: 'amount'; max two decimals), currency (alias: 'payment_currency'; ISO 4217, e.g. 'EUR'), remittance_information. batch_booking accepts JSON true/false. nb_of_txs and ctrl_sum are computed automatically from the records and may be omitted. payment_method defaults to 'TRF' and charge_bearer to 'SLEV'. IBAN and BIC values are strictly validated and never coerced.
message_typeYesA supported ISO 20022 pain message type. Must be exactly one of: 'pain.001.001.03', 'pain.001.001.04', 'pain.001.001.05', 'pain.001.001.06', 'pain.001.001.07', 'pain.001.001.08', 'pain.001.001.09', 'pain.001.001.10', 'pain.001.001.11', 'pain.001.001.12', 'pain.001.001.13', 'pain.008.001.02', 'pain.008.001.08', 'pain.001', 'pain.008' (see list_message_types). The bare family names 'pain.001' and 'pain.008' are accepted as aliases for 'pain.001.001.09' and 'pain.008.001.02'.

Output Schema

NameRequiredDescriptionDefault
errorNo
totalNo
validNo
duplicatesNo
valid_countNo
schema_errorsNo
unique_debtorsNo
unique_creditorsNo
scheme_violationsNo
control_sum_by_currencyNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changedv0.0.87
    • changedOutput schema / $defs / RecordError / description
      Previous value: -"One schema violation: the record's row, the field path, the message."New value: +"One finding: the record's row and line, the field, the code, why.\n\n``row`` counts records from 0 and ``line`` from 1, as the core's\nissues do; ``code`` is the core's stable ``P001-E...`` issue code."
    • addedOutput schema / $defs / RecordError / properties / code
      Added value: +{
      +  "title": "Code",
      +  "type": "string"
      +}
    • addedOutput schema / $defs / RecordError / properties / line
      Added value: +{
      +  "title": "Line",
      +  "type": "integer"
      +}
    • changedOutput schema / $defs / RecordError / required
      Previous value: -[
      -  "row",
      -  "path",
      -  "message"
      -]New value: +[
      +  "row",
      +  "line",
      +  "path",
      +  "code",
      +  "message"
      +]
  2. Changed2 schema fields changedv0.0.84
    • changedInput schema / properties / scheme / anyOf
      Previous value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]New value: +[
      +  {
      +    "enum": [
      +      "ae-uaefts",
      +      "anti-duplicate",
      +      "cbpr-cross-border",
      +      "ch-domestic",
      +      "ch-sepa",
      +      "de-axz",
      +      "de-ccu",
      +      "hk-fps",
      +      "my-duitnow",
      +      "purpose-mandate-ae",
      +      "purpose-mandate-gb",
      +      "purpose-mandate-hk",
      +      "purpose-mandate-my",
      +      "purpose-mandate-qa",
      +      "qa-qatch",
      +      "se-bankgiro",
      +      "sepa-b2b",
      +      "sepa-inst",
      +      "sepa-sct",
      +      "sepa-sdd",
      +      "sg-fast",
      +      "uk-bacs",
      +      "uk-bacs-dd",
      +      "uk-chaps",
      +      "uk-fps",
      +      "us-ach",
      +      "us-rtp",
      +      "us-wire",
      +      "xborder-ct"
      +    ],
      +    "type": "string"
      +  },
      +  {
      +    "pattern": "^(?:\\s*,)*\\s*(?:ae-uaefts|anti-duplicate|cbpr-cross-border|ch-domestic|ch-sepa|de-axz|de-ccu|hk-fps|my-duitnow|purpose-mandate-ae|purpose-mandate-gb|purpose-mandate-hk|purpose-mandate-my|purpose-mandate-qa|qa-qatch|se-bankgiro|sepa-b2b|sepa-inst|sepa-sct|sepa-sdd|sg-fast|uk-bacs|uk-bacs-dd|uk-chaps|uk-fps|us-ach|us-rtp|us-wire|xborder-ct)\\s*(?:,\\s*(?:(?:ae-uaefts|anti-duplicate|cbpr-cross-border|ch-domestic|ch-sepa|de-axz|de-ccu|hk-fps|my-duitnow|purpose-mandate-ae|purpose-mandate-gb|purpose-mandate-hk|purpose-mandate-my|purpose-mandate-qa|qa-qatch|se-bankgiro|sepa-b2b|sepa-inst|sepa-sct|sepa-sdd|sg-fast|uk-bacs|uk-bacs-dd|uk-chaps|uk-fps|us-ach|us-rtp|us-wire|xborder-ct)\\s*)?)*$",
      +    "type": "string"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • changedInput schema / properties / scheme / description
      Previous value: -"Optional payment-scheme rulebook profile to enforce (e.g. 'sepa-sct', 'sepa-sdd', 'sepa-inst', 'xborder-ct'). Omit to skip scheme-specific rulebook validation."New value: +"Optional payment-scheme rulebook profile to enforce, or several joined by commas. One of 'ae-uaefts', 'anti-duplicate', 'cbpr-cross-border', 'ch-domestic', 'ch-sepa', 'de-axz', 'de-ccu', 'hk-fps', 'my-duitnow', 'purpose-mandate-ae', 'purpose-mandate-gb', 'purpose-mandate-hk', 'purpose-mandate-my', 'purpose-mandate-qa', 'qa-qatch', 'se-bankgiro', 'sepa-b2b', 'sepa-inst', 'sepa-sct', 'sepa-sdd', 'sg-fast', 'uk-bacs', 'uk-bacs-dd', 'uk-chaps', 'uk-fps', 'us-ach', 'us-rtp', 'us-wire', 'xborder-ct'. Omit to skip scheme-specific rulebook validation."
  3. Addedv0.0.72

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, non-destructive, closed-world behavior, and the description reinforces that with 'without generating XML or staging files'. It also discloses the actual computations performed (control sums by currency, unique debtor/creditor counts, intra-batch duplicate detection) and the criteria used for duplicates, which is genuine behavioral detail beyond the annotations. It does not discuss any failure modes or limits, but for a read-only dry run that gap is minor.

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 description is front-loaded with the core purpose and the negative scoping statement before the enumerated steps, so an agent gets the essential routing signal in the first two sentences. The numbered list earns its space, though the Args block is redundant with the 100%-covered schema and could be trimmed.

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 annotations covering the safety profile and an output schema covering the return shape, the description only needs to explain what is validated and that nothing is written; it does both. Mentioning that a structured verdict is returned is harmless overlap. Nothing an agent needs to invoke this correctly is missing.

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 all three parameters are already documented in detail, including the comma-joined scheme format and the full record field contract. The Args section largely restates that at a shallower level ('a supported ISO 20022 pain message type', 'optional payment scheme profile') and notably omits the comma-separated multi-scheme capability that the schema specifies. Baseline 3 is appropriate.

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?

Opens with a specific verb and resource ('Simulate and pre-flight a payment batch') and immediately scopes it against the sibling operations by stating it works 'without generating XML or staging files'. The numbered list of five concrete verification steps makes the operation's boundaries unmistakable.

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?

The phrase 'before XML generation' plus the explicit negation of XML generation and file staging tells an agent this is the pre-flight/dry-run step rather than stage_payment_batch or commit_payment_batch. It stops short of naming those siblings directly as alternatives, so routing is strongly implied rather than explicit.

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