Skip to main content
Glama

Validate records against schema

validate_records
Read-onlyIdempotent

Validate flat payment records against an ISO 20022 message type's JSON Schema to catch structural and type errors before generating the XML message. Returns a row-by-row error report.

Instructions

Validate flat records against a message type's input JSON Schema.

Use this before ``generate_message`` to catch structural/type errors
per record and get a row-by-row error report. This checks JSON-Schema
shape only; for payment-scheme rulebook checks (SEPA field lengths,
charset, etc.) also run ``validate_payment_scheme``.

Returns a report ``{"valid": bool, "total": int, "valid_count": int,
"errors": [...]}``.

Args:
    message_type: A supported ISO 20022 pain message type.
    records: One or more flat payment records to validate.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
recordsYesOne or more flat payment records to validate, each a dict of field name → value (see get_input_schema for the fields and get_required_fields for the mandatory ones).
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

TableJSON Schema
NameRequiredDescriptionDefault
errorNo
totalNo
validNo
errorsNo
valid_countNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.0.71
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "$defs": {
      +    "RecordError": {
      +      "description": "One schema violation: the record's row, the field path, the message.",
      +      "properties": {
      +        "message": {
      +          "title": "Message",
      +          "type": "string"
      +        },
      +        "path": {
      +          "title": "Path",
      +          "type": "string"
      +        },
      +        "row": {
      +          "title": "Row",
      +          "type": "integer"
      +        }
      +      },
      +      "required": [
      +        "row",
      +        "path",
      +        "message"
      +      ],
      +      "title": "RecordError",
      +      "type": "object"
      +    }
      +  },
      +  "description": "Verdict over a batch: one entry per violation, plus the counts.",
      +  "properties": {
      +    "error": {
      +      "title": "Error",
      +      "type": "string"
      +    },
      +    "errors": {
      +      "items": {
      +        "$ref": "#/$defs/RecordError"
      +      },
      +      "title": "Errors",
      +      "type": "array"
      +    },
      +    "total": {
      +      "title": "Total",
      +      "type": "integer"
      +    },
      +    "valid": {
      +      "title": "Valid",
      +      "type": "boolean"
      +    },
      +    "valid_count": {
      +      "title": "Valid Count",
      +      "type": "integer"
      +    }
      +  },
      +  "title": "ValidateRecordsResult",
      +  "type": "object"
      +}
  2. Changed2 schema fields changedv0.0.67
    • changedInput schema / properties / message_type / description
      Previous value: -"A 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.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'."New value: +"A 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'."
    • changedInput schema / properties / message_type / enum
      Previous value: -[
      -  "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.001",
      -  "pain.008"
      -]New value: +[
      +  "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"
      +]
  3. Changed2 schema fields changed
    • changedInput schema / properties / message_type / description
      Previous value: -"A 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.008.001.02', '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'."New value: +"A 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.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'."
    • changedInput schema / properties / message_type / enum
      Previous value: -[
      -  "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.008.001.02",
      -  "pain.001",
      -  "pain.008"
      -]New value: +[
      +  "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.001",
      +  "pain.008"
      +]
  4. Addedv0.0.60
  5. Removed
  6. Changed2 schema fields changed
    • changedInput schema / properties / message_type / description
      Previous value: -"A 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.008.001.02' (see list_message_types)."New value: +"A 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.008.001.02', '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'."
    • changedInput schema / properties / message_type / enum
      Previous value: -[
      -  "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.008.001.02"
      -]New value: +[
      +  "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.008.001.02",
      +  "pain.001",
      +  "pain.008"
      +]
  7. Changed2 schema fields changedv0.0.57
    • changedInput schema / properties / message_type / description
      Previous value: -"A supported ISO 20022 pain message type whose input JSON Schema the records are checked against, e.g. 'pain.001.001.09' — see list_message_types."New value: +"A 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.008.001.02' (see list_message_types)."
    • addedInput schema / properties / message_type / enum
      Added value: +[
      +  "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.008.001.02"
      +]
  8. Changed2 schema fields changedv0.0.56
    • addedInput schema / properties / message_type / description
      Added value: +"A supported ISO 20022 pain message type whose input JSON Schema the records are checked against, e.g. 'pain.001.001.09' — see list_message_types."
    • addedInput schema / properties / records / description
      Added value: +"One or more flat payment records to validate, each a dict of field name → value (see get_input_schema for the fields and get_required_fields for the mandatory ones)."
  9. First observed

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint and idempotentHint, and the description adds valuable behavior beyond that: it checks JSON-Schema shape only, reports row-by-row errors, and returns a specific report structure. No contradiction with annotations.

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 well structured and front-loaded: purpose, usage, return format, then args. The Args block is somewhat redundant with the input schema, but the usage and return-format sentences earn their place.

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?

For a two-parameter read-only validation tool with complete schema annotations and sibling references, the description covers purpose, usage, limitations, and return shape. Nothing needed to call it 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?

Input schema coverage is 100%, so the schema already documents message_type and records with details like the enum and references to get_input_schema/get_required_fields. The Args section in the description mostly repeats this rather than adding new semantic detail, so 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?

The description opens with a specific verb and object: 'Validate flat records against a message type's input JSON Schema.' It clearly separates this validation tool from sibling validate_payment_scheme by naming the alternative and the different check performed.

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?

It says exactly when to use it ('Use this before generate_message to catch structural/type errors') and when to use an alternative ('for payment-scheme rulebook checks... also run validate_payment_scheme'). This is explicit routing between siblings with no inference required.

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