Skip to main content
Glama

allele_info

Read-onlyIdempotent

Look up one name in the pinned release and return what it is: assigned (G/P group, first release, confirmed status, WMDA serology, null flag), valid_prefix (member count and sample, plus resolution: what a name with fewer than four fields does and does not distinguish), group (a G or P group name: member count and sample), or deleted (successor). Reported shorthands are accepted as /v1/normalize accepts them — legacy spellings (A0101, Cw0702, Cw07:02), the XX code (A02:XX), two-field A02:01g, an optional HLA- prefix — and answer with the facts of the name they stand for plus resolves_to and a flag (deprecated_name, xx_code, lg_notation); an NMDP multiple allele code (A02:AB) returns mac_code, recognised but not expanded. A name that has never existed in any release is refused, not guessed at: the tool returns an error result (HTTP 404 on /v1/allele) and never a near match. A deleted name is answered as deleted, with its successor when the release records one.

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": "allele_info"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameYesAn HLA allele name of any era: exact name, lower-resolution prefix, deleted name, G/P group, legacy colon-less name, XX code or lg notation. An allele string only, never a patient name, medical record number or other identifier.

Output Schema

NameRequiredDescriptionDefault
nameNo
noteNomac_code: what a multiple allele code is and why it is not expanded.
flagsNoPresent for a shorthand: deprecated_name (legacy spelling: colon-less A*0101, or the Cw locus label as in Cw*07:02), xx_code, lg_notation, or mac_code. Absent for a plain name.
detailNoPresent only when the name is not assigned in this release (and then no other field is).
statusNoassigned: an exact allele in this release; valid_prefix: a lower-resolution prefix of assigned alleles; group: a G or P group name (see group_type); deleted: withdrawn or renamed (see successor); mac_code: an NMDP multiple allele code (A*02:AB), recognised but not expanded or checked.
g_groupNoassigned: G group, or null.
ligandsNoClass I (A/B/C) ligand facts, aggregated over member alleles: 'ambiguous' when members disagree, 'unknown' when no residue data.
p_groupNoassigned: P group, or null.
releaseNoIPD-IMGT/HLA release every verdict was computed against.
serologyNoassigned: WMDA serologic equivalents by column (non-empty columns only), as published in rel_dna_ser.txt: an antigen number, '?' (undetermined equivalent) or '∅' (no serological equivalent, null). The lab tools report these as 'uncertain' and 'null'.
confirmedNoassigned: confirmed (vs unconfirmed) allele.
successorNodeleted: the current name, or null if none.
group_typeNogroup: whether the name is a G group (identical exons 2+3 / exon 2) or a P group (identical peptide-binding domain).
resolutionNoPresent on a name with fewer than four fields: what this resolution level does and does not distinguish.
attributionNoData attribution (IPD-IMGT/HLA, CC-BY-ND).
null_alleleNoassigned: true for an N (null, not expressed) allele.
resolves_toNoPresent when the name was a reported shorthand (legacy colon-less or Cw spelling, XX code, lg notation): the current-style name it stands for, whose facts this result carries.
first_releaseNoassigned: first release the exact name appeared in.
members_countNovalid_prefix / group: number of assigned alleles under the prefix or in the group.
members_sampleNovalid_prefix / group: up to 10 member alleles.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedOutput schema / properties / serology / description
      Previous value: -"assigned: WMDA serologic equivalents by column (non-empty columns only)."New value: +"assigned: WMDA serologic equivalents by column (non-empty columns only), as published in rel_dna_ser.txt: an antigen number, '?' (undetermined equivalent) or '∅' (no serological equivalent, null). The lab tools report these as 'uncertain' and 'null'."
  2. Changed1 schema field changed
    • addedOutput schema / properties / resolution
      Added value: +{
      +  "description": "Present on a name with fewer than four fields: what this resolution level does and does not distinguish.",
      +  "properties": {
      +    "distinguishes": {
      +      "description": "What finer typing at the next field would add.",
      +      "type": "string"
      +    },
      +    "fields": {
      +      "description": "Number of colon-separated fields in the name.",
      +      "enum": [
      +        1,
      +        2,
      +        3
      +      ],
      +      "type": "integer"
      +    },
      +    "level": {
      +      "description": "1 field: allele_group; 2: protein; 3: coding_sequence.",
      +      "enum": [
      +        "allele_group",
      +        "protein",
      +        "coding_sequence"
      +      ],
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "fields",
      +    "level",
      +    "distinguishes"
      +  ],
      +  "type": "object"
      +}
  3. Changed2 schema fields changed
    • changedOutput schema / properties / flags / description
      Previous value: -"Present for a shorthand: deprecated_name (legacy colon-less name), xx_code, lg_notation, or mac_code. Absent for a plain name."New value: +"Present for a shorthand: deprecated_name (legacy spelling: colon-less A*0101, or the Cw locus label as in Cw*07:02), xx_code, lg_notation, or mac_code. Absent for a plain name."
    • changedOutput schema / properties / resolves_to / description
      Previous value: -"Present when the name was a reported shorthand (legacy colon-less, XX code, lg notation): the current-style name it stands for, whose facts this result carries."New value: +"Present when the name was a reported shorthand (legacy colon-less or Cw spelling, XX code, lg notation): the current-style name it stands for, whose facts this result carries."
  4. Changed6 schema fields changed
    • changedInput schema / properties / name / description
      Previous value: -"Exact HLA allele name, a lower-resolution prefix, or a deleted name. An allele string only, never a patient name, medical record number or other identifier."New value: +"An HLA allele name of any era: exact name, lower-resolution prefix, deleted name, G/P group, legacy colon-less name, XX code or lg notation. An allele string only, never a patient name, medical record number or other identifier."
    • addedOutput schema / properties / flags
      Added value: +{
      +  "description": "Present for a shorthand: deprecated_name (legacy colon-less name), xx_code, lg_notation, or mac_code. Absent for a plain name.",
      +  "items": {
      +    "type": "string"
      +  },
      +  "type": "array"
      +}
    • addedOutput schema / properties / note
      Added value: +{
      +  "description": "mac_code: what a multiple allele code is and why it is not expanded.",
      +  "type": "string"
      +}
    • addedOutput schema / properties / resolves_to
      Added value: +{
      +  "description": "Present when the name was a reported shorthand (legacy colon-less, XX code, lg notation): the current-style name it stands for, whose facts this result carries.",
      +  "type": "string"
      +}
    • changedOutput schema / properties / status / description
      Previous value: -"assigned: an exact allele in this release; valid_prefix: a lower-resolution prefix of assigned alleles; group: a G or P group name (see group_type); deleted: withdrawn or renamed (see successor)."New value: +"assigned: an exact allele in this release; valid_prefix: a lower-resolution prefix of assigned alleles; group: a G or P group name (see group_type); deleted: withdrawn or renamed (see successor); mac_code: an NMDP multiple allele code (A*02:AB), recognised but not expanded or checked."
    • changedOutput schema / properties / status / enum
      Previous value: -[
      -  "assigned",
      -  "valid_prefix",
      -  "group",
      -  "deleted"
      -]New value: +[
      +  "assigned",
      +  "valid_prefix",
      +  "group",
      +  "deleted",
      +  "mac_code"
      +]
  5. Changed5 schema fields changed
    • addedOutput schema / properties / group_type
      Added value: +{
      +  "description": "group: whether the name is a G group (identical exons 2+3 / exon 2) or a P group (identical peptide-binding domain).",
      +  "enum": [
      +    "G",
      +    "P"
      +  ],
      +  "type": "string"
      +}
    • changedOutput schema / properties / members_count / description
      Previous value: -"valid_prefix: number of assigned alleles under the prefix."New value: +"valid_prefix / group: number of assigned alleles under the prefix or in the group."
    • changedOutput schema / properties / members_sample / description
      Previous value: -"valid_prefix: up to 10 member alleles."New value: +"valid_prefix / group: up to 10 member alleles."
    • changedOutput schema / properties / status / description
      Previous value: -"assigned: an exact allele in this release; valid_prefix: a lower-resolution prefix of assigned alleles; deleted: withdrawn or renamed (see successor)."New value: +"assigned: an exact allele in this release; valid_prefix: a lower-resolution prefix of assigned alleles; group: a G or P group name (see group_type); deleted: withdrawn or renamed (see successor)."
    • changedOutput schema / properties / status / enum
      Previous value: -[
      -  "assigned",
      -  "valid_prefix",
      -  "deleted"
      -]New value: +[
      +  "assigned",
      +  "valid_prefix",
      +  "group",
      +  "deleted"
      +]
  6. Changed1 schema field changed
    • changedInput schema / properties / name / description
      Previous value: -"Exact allele, prefix, or deleted name."New value: +"Exact HLA allele name, a lower-resolution prefix, or a deleted name. An allele string only, never a patient name, medical record number or other identifier."
  7. First observed

TDQS

A3.9/5.0
Behavior5/5

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

Annotations already declare readOnly/idempotent/closed-world, and the description adds substantial context on top: the exact failure mode (error result, HTTP 404 on /v1/allele, never a near match), how deleted names are answered, and that MAC codes are recognised but not expanded. This is exactly the kind of behaviour an agent cannot get from the annotations alone.

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 clause is well front-loaded, but the second sentence is a long run-on stacking examples and flag names, and the shorthand enumeration is partly redundant with the schema's own description of accepted forms. The '(HTTP 404 on /v1/allele)' detail is endpoint trivia mixed into a semantic description.

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?

For a single-parameter lookup with an output schema and full annotation coverage, the description is close to complete: it covers input forms, outcome classes, and failure behaviour. The remaining gap is that 'the pinned release' is never defined — which release, or whether it can be changed — leaving an agent unsure about data vintage.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the baseline is 3, but the description goes further by enumerating accepted input forms — legacy colon-less spellings, Cw prefixes, XX codes, lg notation, optional HLA- prefix — and by naming the flags returned for each (deprecated_name, xx_code, lg_notation, resolves_to). That materially expands what the single `name` parameter means.

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 — 'look up one name in the pinned release and return what it is' — and enumerates the four outcome classes (assigned, valid_prefix, group, deleted), which lets an agent predict the shape of the answer. It stops short of naming the siblings it is not (allele_history, normalize_allele), so differentiation is inferred rather than stated.

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

Usage Guidelines3/5

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

Useful behavioural routing is present: unknown names are refused rather than fuzzy-matched, deleted names return a successor, and NMDP MAC codes are recognised but not expanded. However, there is no explicit statement of when to pick this tool over allele_history or normalize_allele, which are the obvious alternatives among the siblings.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.