Skip to main content
Glama

Get required fields

get_required_fields
Read-onlyIdempotent

List the required input field names for a specified ISO 20022 pain message type. Use this for a quick checklist before building payment records.

Instructions

List only the required input field names for a pain message type.

Use this for a quick checklist of the mandatory columns before building
records. When you need full type/format constraints (not just which
fields are required), call ``get_input_schema`` instead.

Args:
    message_type: A supported ISO 20022 pain message type.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
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
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. 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"
      +]
  2. 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"
      +]
  3. Addedv0.0.60
  4. Removed
  5. 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"
      +]
  6. Changed2 schema fields changedv0.0.57
    • changedInput schema / properties / message_type / description
      Previous value: -"A supported ISO 20022 pain message type, e.g. 'pain.001.001.09' — see list_message_types for the exact accepted strings."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"
      +]
  7. Changed1 schema field changedv0.0.56
    • addedInput schema / properties / message_type / description
      Added value: +"A supported ISO 20022 pain message type, e.g. 'pain.001.001.09' — see list_message_types for the exact accepted strings."
  8. First observed

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint and destructiveHint=false, so safety is covered. The description adds genuine behavioral detail beyond that: the output is narrow (field names only, not type/format constraints), which is exactly the distinction an agent needs when choosing between this and get_input_schema.

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?

Three short sentences, front-loaded with the scope limit followed by usage and the alternative. The Args block is mildly redundant with the schema but costs almost nothing and no sentence is wasted.

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?

An output schema exists, so return values need no explanation, and the single parameter is fully documented in the schema. For a one-argument, read-only lookup tool, the description plus structured fields leave no gap an agent would need to guess around.

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 100% and the enum description already lists every accepted value plus the pain.001/pain.008 alias behavior, so the schema carries the parameter semantics. The description's only addition is the one-line restatement 'A supported ISO 20022 pain message type', which does not extend meaning beyond the schema.

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?

States a specific verb (List) and resource (required input field names) with an explicit scope limiter ('only the required' for 'a pain message type'). This clearly separates it from get_input_schema, which the description names as the sibling covering the broader case.

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?

Explicit when-to-use ('quick checklist of the mandatory columns before building records') and explicit when-to-use-something-else ('When you need full type/format constraints... call get_input_schema instead'). Routing conditions are unambiguous.

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