allele_info
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
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | 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. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | ||
| note | No | mac_code: what a multiple allele code is and why it is not expanded. | |
| flags | No | 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. | |
| detail | No | Present only when the name is not assigned in this release (and then no other field is). | |
| status | No | 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. | |
| g_group | No | assigned: G group, or null. | |
| ligands | No | Class I (A/B/C) ligand facts, aggregated over member alleles: 'ambiguous' when members disagree, 'unknown' when no residue data. | |
| p_group | No | assigned: P group, or null. | |
| release | No | IPD-IMGT/HLA release every verdict was computed against. | |
| serology | No | 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'. | |
| confirmed | No | assigned: confirmed (vs unconfirmed) allele. | |
| successor | No | deleted: the current name, or null if none. | |
| group_type | No | group: whether the name is a G group (identical exons 2+3 / exon 2) or a P group (identical peptide-binding domain). | |
| resolution | No | Present on a name with fewer than four fields: what this resolution level does and does not distinguish. | |
| attribution | No | Data attribution (IPD-IMGT/HLA, CC-BY-ND). | |
| null_allele | No | assigned: true for an N (null, not expressed) allele. | |
| resolves_to | No | 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. | |
| first_release | No | assigned: first release the exact name appeared in. | |
| members_count | No | valid_prefix / group: number of assigned alleles under the prefix or in the group. | |
| members_sample | No | valid_prefix / group: up to 10 member alleles. |