Skip to main content
Glama
SidneyBissoli

UNESCO UIS Education Statistics MCP

Search UNESCO UIS indicators

uis_search_indicators
Read-onlyIdempotent

Search ~5,000 UNESCO UIS indicators by keyword or theme to find indicator codes and data availability for retrieving education, science, culture or socioeconomic statistics.

Instructions

Search the UNESCO Institute for Statistics catalogue of ~5,000 indicators — education, science/R&D, culture and communication — by keywords in the name or code, optionally filtered by theme. All terms must match (AND, case-insensitive), so start with 2–3 words and drop terms if you get 0 results. Everyday and US wording is resolved to the UIS's own (enrollment→enrolment, spending→expenditure, preschool→pre-primary, university→tertiary, graduation→completion, girls/boys→female/male); when that happens the response says so in vocabulary_notes. Returns indicator codes to use with uis_get_data, plus each indicator's data availability (years, record count). Searches the catalogue only — it does not return statistical values (use uis_get_data); ILO labour statistics live in the sibling ILOSTAT MCP server.

Input Schema

NameRequiredDescriptionDefault
limitNoMaximum results (default 20)
queryYesKeywords, matched against indicator name and code, AND between terms (e.g. "literacy rate youth")
themeNoRestrict to one UIS theme
offsetNoResults to skip, for pagination (default 0)
provenance_modeNoProvenance verbosity: 'concise' (default — source, url, vintage, retrieval date, citation, license) or 'detailed' (full canonical block with dataset, dimension key and notices)

Output Schema

NameRequiredDescriptionDefault
hintNoWhat to do next: how to narrow or page, or why nothing matched
offsetYesResults skipped before this page
showingYesIndicators returned in this page
has_moreYesTrue when more matches remain after this page
indicatorsYesMatching indicators, largest record count first; use code with uis_get_data
provenanceYesProvenance block of the portfolio. concise (default): source, source_url, data_vintage, retrieved_at, retrieval, citation, license, plus optional keys only when there is something to say (field_sources, notices, derived/derivation_note, revision); detailed: the full canonical block (dataset, dimension_key, notices, served_from_cache, ...). retrieval is the origin diagnostic of this call — requests made to the UIS Data API, attempts including retries, anomalies overcome (timeout, network, rate_limited, http_5xx, http_4xx, malformed_body) and unstable (true when anything had to be retried: treat the figures as obtained with difficulty); null when nothing was fetched from the UIS (catalogue or cached answer)
attributionYesSource URLs the figures came from (the provenance source_url of each block), for linking the citation
next_offsetNoOffset for the next page; present only when has_more is true
total_matchesYesIndicators matching all terms, across every page
vocabulary_notesNoTranslations applied from everyday or US wording to UIS terms (e.g. enrollment → enrolment)

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed9 schema fields changedv1.9.0
    • addedOutput schema / properties / attribution / description
      Added value: +"Source URLs the figures came from (the provenance source_url of each block), for linking the citation"
    • addedOutput schema / properties / has_more / description
      Added value: +"True when more matches remain after this page"
    • addedOutput schema / properties / hint / description
      Added value: +"What to do next: how to narrow or page, or why nothing matched"
    • addedOutput schema / properties / indicators / description
      Added value: +"Matching indicators, largest record count first; use code with uis_get_data"
    • addedOutput schema / properties / next_offset / description
      Added value: +"Offset for the next page; present only when has_more is true"
    • addedOutput schema / properties / offset / description
      Added value: +"Results skipped before this page"
    • addedOutput schema / properties / showing / description
      Added value: +"Indicators returned in this page"
    • addedOutput schema / properties / total_matches / description
      Added value: +"Indicators matching all terms, across every page"
    • addedOutput schema / properties / vocabulary_notes / description
      Added value: +"Translations applied from everyday or US wording to UIS terms (e.g. enrollment → enrolment)"
  2. Changed2 schema fields changedv1.6.0
    • changedOutput schema / properties / provenance / anyOf
      Previous value: -[
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "citation": {
      -        "type": "string"
      -      },
      -      "data_vintage": {
      -        "type": [
      -          "string",
      -          "null"
      -        ]
      -      },
      -      "field_sources": {
      -        "items": {
      -          "additionalProperties": false,
      -          "properties": {
      -            "data_vintage": {
      -              "type": [
      -                "string",
      -                "null"
      -              ]
      -            },
      -            "dataset_id": {
      -              "type": [
      -                "string",
      -                "null"
      -              ]
      -            },
      -            "fields": {
      -              "items": {
      -                "type": "string"
      -              },
      -              "minItems": 1,
      -              "type": "array"
      -            },
      -            "retrieved_at": {
      -              "type": [
      -                "string",
      -                "null"
      -              ]
      -            },
      -            "served_from_cache": {
      -              "type": [
      -                "boolean",
      -                "null"
      -              ]
      -            },
      -            "source_url": {
      -              "type": "string"
      -            }
      -          },
      -          "required": [
      -            "fields",
      -            "source_url",
      -            "dataset_id",
      -            "data_vintage",
      -            "retrieved_at"
      -          ],
      -          "type": "object"
      -        },
      -        "minItems": 1,
      -        "type": "array"
      -      },
      -      "license": {
      -        "type": [
      -          "string",
      -          "null"
      -        ]
      -      },
      -      "retrieval": {
      -        "anyOf": [
      -          {
      -            "additionalProperties": false,
      -            "properties": {
      -              "anomalies": {
      -                "items": {
      -                  "additionalProperties": false,
      -                  "properties": {
      -                    "count": {
      -                      "maximum": 9007199254740991,
      -                      "minimum": 1,
      -                      "type": "integer"
      -                    },
      -                    "kind": {
      -                      "enum": [
      -                        "timeout",
      -                        "network",
      -                        "http_4xx",
      -                        "http_5xx",
      -                        "rate_limited",
      -                        "malformed_body"
      -                      ],
      -                      "type": "string"
      -                    }
      -                  },
      -                  "required": [
      -                    "kind",
      -                    "count"
      -                  ],
      -                  "type": "object"
      -                },
      -                "type": "array"
      -              },
      -              "attempts": {
      -                "maximum": 9007199254740991,
      -                "minimum": 1,
      -                "type": "integer"
      -              },
      -              "requests": {
      -                "maximum": 9007199254740991,
      -                "minimum": 1,
      -                "type": "integer"
      -              },
      -              "unstable": {
      -                "type": "boolean"
      -              }
      -            },
      -            "required": [
      -              "requests",
      -              "attempts",
      -              "anomalies",
      -              "unstable"
      -            ],
      -            "type": "object"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ]
      -      },
      -      "retrieved_at": {
      -        "type": "string"
      -      },
      -      "source": {
      -        "type": "string"
      -      },
      -      "source_url": {
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "source",
      -      "source_url",
      -      "data_vintage",
      -      "retrieved_at",
      -      "retrieval",
      -      "citation",
      -      "license"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "api_version": {
      -        "type": [
      -          "string",
      -          "null"
      -        ]
      -      },
      -      "citation": {
      -        "type": "string"
      -      },
      -      "contract_version": {
      -        "enum": [
      -          "1.1",
      -          "1.2"
      -        ],
      -        "type": "string"
      -      },
      -      "data_vintage": {
      -        "type": [
      -          "string",
      -          "null"
      -        ]
      -      },
      -      "dataset": {
      -        "additionalProperties": false,
      -        "properties": {
      -          "id": {
      -            "type": [
      -              "string",
      -              "null"
      -            ]
      -          },
      -          "name": {
      -            "type": [
      -              "string",
      -              "null"
      -            ]
      -          },
      -          "version": {
      -            "type": [
      -              "string",
      -              "null"
      -            ]
      -          }
      -        },
      -        "required": [
      -          "id",
      -          "version",
      -          "name"
      -        ],
      -        "type": "object"
      -      },
      -      "derivation_note": {
      -        "type": [
      -          "string",
      -          "null"
      -        ]
      -      },
      -      "derived": {
      -        "type": "boolean"
      -      },
      -      "dimension_key": {
      -        "anyOf": [
      -          {
      -            "additionalProperties": {
      -              "type": "string"
      -            },
      -            "propertyNames": {
      -              "type": "string"
      -            },
      -            "type": "object"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ]
      -      },
      -      "field_sources": {
      -        "anyOf": [
      -          {
      -            "items": {
      -              "additionalProperties": false,
      -              "properties": {
      -                "data_vintage": {
      -                  "type": [
      -                    "string",
      -                    "null"
      -                  ]
      -                },
      -                "dataset_id": {
      -                  "type": [
      -                    "string",
      -                    "null"
      -                  ]
      -                },
      -                "fields": {
      -                  "items": {
      -                    "type": "string"
      -                  },
      -                  "minItems": 1,
      -                  "type": "array"
      -                },
      -                "retrieved_at": {
      -                  "type": [
      -                    "string",
      -                    "null"
      -                  ]
      -                },
      -                "served_from_cache": {
      -                  "type": [
      -                    "boolean",
      -                    "null"
      -                  ]
      -                },
      -                "source_url": {
      -                  "type": "string"
      -                }
      -              },
      -              "required": [
      -                "fields",
      -                "source_url",
      -                "dataset_id",
      -                "data_vintage",
      -                "retrieved_at"
      -              ],
      -              "type": "object"
      -            },
      -            "type": "array"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ]
      -      },
      -      "license": {
      -        "additionalProperties": false,
      -        "properties": {
      -          "id": {
      -            "type": [
      -              "string",
      -              "null"
      -            ]
      -          },
      -          "name": {
      -            "type": [
      -              "string",
      -              "null"
      -            ]
      -          },
      -          "terms_url": {
      -            "type": [
      -              "string",
      -              "null"
      -            ]
      -          },
      -          "url": {
      -            "type": [
      -              "string",
      -              "null"
      -            ]
      -          },
      -          "verified_at": {
      -            "type": [
      -              "string",
      -              "null"
      -            ]
      -          }
      -        },
      -        "required": [
      -          "id",
      -          "name",
      -          "url",
      -          "terms_url",
      -          "verified_at"
      -        ],
      -        "type": "object"
      -      },
      -      "notices": {
      -        "items": {
      -          "type": "string"
      -        },
      -        "type": "array"
      -      },
      -      "retrieval": {
      -        "anyOf": [
      -          {
      -            "additionalProperties": false,
      -            "properties": {
      -              "anomalies": {
      -                "items": {
      -                  "additionalProperties": false,
      -                  "properties": {
      -                    "count": {
      -                      "maximum": 9007199254740991,
      -                      "minimum": 1,
      -                      "type": "integer"
      -                    },
      -                    "kind": {
      -                      "enum": [
      -                        "timeout",
      -                        "network",
      -                        "http_4xx",
      -                        "http_5xx",
      -                        "rate_limited",
      -                        "malformed_body"
      -                      ],
      -                      "type": "string"
      -                    }
      -                  },
      -                  "required": [
      -                    "kind",
      -                    "count"
      -                  ],
      -                  "type": "object"
      -                },
      -                "type": "array"
      -              },
      -              "attempts": {
      -                "maximum": 9007199254740991,
      -                "minimum": 1,
      -                "type": "integer"
      -              },
      -              "requests": {
      -                "maximum": 9007199254740991,
      -                "minimum": 1,
      -                "type": "integer"
      -              },
      -              "unstable": {
      -                "type": "boolean"
      -              }
      -            },
      -            "required": [
      -              "requests",
      -              "attempts",
      -              "anomalies",
      -              "unstable"
      -            ],
      -            "type": "object"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ]
      -      },
      -      "retrieved_at": {
      -        "type": "string"
      -      },
      -      "served_from_cache": {
      -        "type": [
      -          "boolean",
      -          "null"
      -        ]
      -      },
      -      "source": {
      -        "additionalProperties": false,
      -        "properties": {
      -          "agency": {
      -            "type": [
      -              "string",
      -              "null"
      -            ]
      -          },
      -          "database": {
      -            "type": [
      -              "string",
      -              "null"
      -            ]
      -          },
      -          "endpoint": {
      -            "type": [
      -              "string",
      -              "null"
      -            ]
      -          },
      -          "name": {
      -            "type": "string"
      -          }
      -        },
      -        "required": [
      -          "name",
      -          "agency",
      -          "database",
      -          "endpoint"
      -        ],
      -        "type": "object"
      -      },
      -      "source_url": {
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "contract_version",
      -      "source",
      -      "dataset",
      -      "dimension_key",
      -      "data_vintage",
      -      "retrieved_at",
      -      "source_url",
      -      "api_version",
      -      "license",
      -      "citation",
      -      "notices",
      -      "derived",
      -      "derivation_note",
      -      "served_from_cache",
      -      "retrieval",
      -      "field_sources"
      -    ],
      -    "type": "object"
      -  }
      -]New value: +[
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "citation": {
      +        "type": "string"
      +      },
      +      "data_vintage": {
      +        "type": [
      +          "string",
      +          "null"
      +        ]
      +      },
      +      "derivation_note": {
      +        "type": "string"
      +      },
      +      "derived": {
      +        "type": "boolean"
      +      },
      +      "field_sources": {
      +        "items": {
      +          "additionalProperties": false,
      +          "properties": {
      +            "data_vintage": {
      +              "type": [
      +                "string",
      +                "null"
      +              ]
      +            },
      +            "dataset_id": {
      +              "type": [
      +                "string",
      +                "null"
      +              ]
      +            },
      +            "fields": {
      +              "items": {
      +                "type": "string"
      +              },
      +              "minItems": 1,
      +              "type": "array"
      +            },
      +            "retrieved_at": {
      +              "type": [
      +                "string",
      +                "null"
      +              ]
      +            },
      +            "served_from_cache": {
      +              "type": [
      +                "boolean",
      +                "null"
      +              ]
      +            },
      +            "source_url": {
      +              "type": "string"
      +            }
      +          },
      +          "required": [
      +            "fields",
      +            "source_url",
      +            "dataset_id",
      +            "data_vintage",
      +            "retrieved_at"
      +          ],
      +          "type": "object"
      +        },
      +        "minItems": 1,
      +        "type": "array"
      +      },
      +      "license": {
      +        "type": [
      +          "string",
      +          "null"
      +        ]
      +      },
      +      "notices": {
      +        "items": {
      +          "type": "string"
      +        },
      +        "minItems": 1,
      +        "type": "array"
      +      },
      +      "retrieval": {
      +        "anyOf": [
      +          {
      +            "additionalProperties": false,
      +            "properties": {
      +              "anomalies": {
      +                "items": {
      +                  "additionalProperties": false,
      +                  "properties": {
      +                    "count": {
      +                      "maximum": 9007199254740991,
      +                      "minimum": 1,
      +                      "type": "integer"
      +                    },
      +                    "kind": {
      +                      "enum": [
      +                        "timeout",
      +                        "network",
      +                        "http_4xx",
      +                        "http_5xx",
      +                        "rate_limited",
      +                        "malformed_body"
      +                      ],
      +                      "type": "string"
      +                    }
      +                  },
      +                  "required": [
      +                    "kind",
      +                    "count"
      +                  ],
      +                  "type": "object"
      +                },
      +                "type": "array"
      +              },
      +              "attempts": {
      +                "maximum": 9007199254740991,
      +                "minimum": 1,
      +                "type": "integer"
      +              },
      +              "requests": {
      +                "maximum": 9007199254740991,
      +                "minimum": 1,
      +                "type": "integer"
      +              },
      +              "unstable": {
      +                "type": "boolean"
      +              }
      +            },
      +            "required": [
      +              "requests",
      +              "attempts",
      +              "anomalies",
      +              "unstable"
      +            ],
      +            "type": "object"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ]
      +      },
      +      "retrieved_at": {
      +        "type": "string"
      +      },
      +      "revision": {
      +        "additionalProperties": false,
      +        "properties": {
      +          "note": {
      +            "type": [
      +              "string",
      +              "null"
      +            ]
      +          },
      +          "status": {
      +            "enum": [
      +              "current",
      +              "provisional",
      +              "final"
      +            ],
      +            "type": "string"
      +          }
      +        },
      +        "required": [
      +          "status",
      +          "note"
      +        ],
      +        "type": "object"
      +      },
      +      "source": {
      +        "type": "string"
      +      },
      +      "source_url": {
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "source",
      +      "source_url",
      +      "data_vintage",
      +      "retrieved_at",
      +      "retrieval",
      +      "citation",
      +      "license"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "api_version": {
      +        "type": [
      +          "string",
      +          "null"
      +        ]
      +      },
      +      "citation": {
      +        "type": "string"
      +      },
      +      "contract_version": {
      +        "enum": [
      +          "1.1",
      +          "1.2",
      +          "1.3"
      +        ],
      +        "type": "string"
      +      },
      +      "data_vintage": {
      +        "type": [
      +          "string",
      +          "null"
      +        ]
      +      },
      +      "dataset": {
      +        "additionalProperties": false,
      +        "properties": {
      +          "id": {
      +            "type": [
      +              "string",
      +              "null"
      +            ]
      +          },
      +          "name": {
      +            "type": [
      +              "string",
      +              "null"
      +            ]
      +          },
      +          "version": {
      +            "type": [
      +              "string",
      +              "null"
      +            ]
      +          }
      +        },
      +        "required": [
      +          "id",
      +          "version",
      +          "name"
      +        ],
      +        "type": "object"
      +      },
      +      "derivation_note": {
      +        "type": [
      +          "string",
      +          "null"
      +        ]
      +      },
      +      "derived": {
      +        "type": "boolean"
      +      },
      +      "dimension_key": {
      +        "anyOf": [
      +          {
      +            "additionalProperties": {
      +              "type": "string"
      +            },
      +            "propertyNames": {
      +              "type": "string"
      +            },
      +            "type": "object"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ]
      +      },
      +      "field_sources": {
      +        "anyOf": [
      +          {
      +            "items": {
      +              "additionalProperties": false,
      +              "properties": {
      +                "data_vintage": {
      +                  "type": [
      +                    "string",
      +                    "null"
      +                  ]
      +                },
      +                "dataset_id": {
      +                  "type": [
      +                    "string",
      +                    "null"
      +                  ]
      +                },
      +                "fields": {
      +                  "items": {
      +                    "type": "string"
      +                  },
      +                  "minItems": 1,
      +                  "type": "array"
      +                },
      +                "retrieved_at": {
      +                  "type": [
      +                    "string",
      +                    "null"
      +                  ]
      +                },
      +                "served_from_cache": {
      +                  "type": [
      +                    "boolean",
      +                    "null"
      +                  ]
      +                },
      +                "source_url": {
      +                  "type": "string"
      +                }
      +              },
      +              "required": [
      +                "fields",
      +                "source_url",
      +                "dataset_id",
      +                "data_vintage",
      +                "retrieved_at"
      +              ],
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ]
      +      },
      +      "license": {
      +        "additionalProperties": false,
      +        "properties": {
      +          "id": {
      +            "type": [
      +              "string",
      +              "null"
      +            ]
      +          },
      +          "name": {
      +            "type": [
      +              "string",
      +              "null"
      +            ]
      +          },
      +          "terms_url": {
      +            "type": [
      +              "string",
      +              "null"
      +            ]
      +          },
      +          "url": {
      +            "type": [
      +              "string",
      +              "null"
      +            ]
      +          },
      +          "verified_at": {
      +            "type": [
      +              "string",
      +              "null"
      +            ]
      +          }
      +        },
      +        "required": [
      +          "id",
      +          "name",
      +          "url",
      +          "terms_url",
      +          "verified_at"
      +        ],
      +        "type": "object"
      +      },
      +      "notices": {
      +        "items": {
      +          "type": "string"
      +        },
      +        "type": "array"
      +      },
      +      "retrieval": {
      +        "anyOf": [
      +          {
      +            "additionalProperties": false,
      +            "properties": {
      +              "anomalies": {
      +                "items": {
      +                  "additionalProperties": false,
      +                  "properties": {
      +                    "count": {
      +                      "maximum": 9007199254740991,
      +                      "minimum": 1,
      +                      "type": "integer"
      +                    },
      +                    "kind": {
      +                      "enum": [
      +                        "timeout",
      +                        "network",
      +                        "http_4xx",
      +                        "http_5xx",
      +                        "rate_limited",
      +                        "malformed_body"
      +                      ],
      +                      "type": "string"
      +                    }
      +                  },
      +                  "required": [
      +                    "kind",
      +                    "count"
      +                  ],
      +                  "type": "object"
      +                },
      +                "type": "array"
      +              },
      +              "attempts": {
      +                "maximum": 9007199254740991,
      +                "minimum": 1,
      +                "type": "integer"
      +              },
      +              "requests": {
      +                "maximum": 9007199254740991,
      +                "minimum": 1,
      +                "type": "integer"
      +              },
      +              "unstable": {
      +                "type": "boolean"
      +              }
      +            },
      +            "required": [
      +              "requests",
      +              "attempts",
      +              "anomalies",
      +              "unstable"
      +            ],
      +            "type": "object"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ]
      +      },
      +      "retrieved_at": {
      +        "type": "string"
      +      },
      +      "revision": {
      +        "anyOf": [
      +          {
      +            "additionalProperties": false,
      +            "properties": {
      +              "note": {
      +                "type": [
      +                  "string",
      +                  "null"
      +                ]
      +              },
      +              "status": {
      +                "enum": [
      +                  "current",
      +                  "provisional",
      +                  "final"
      +                ],
      +                "type": "string"
      +              }
      +            },
      +            "required": [
      +              "status",
      +              "note"
      +            ],
      +            "type": "object"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ]
      +      },
      +      "served_from_cache": {
      +        "type": [
      +          "boolean",
      +          "null"
      +        ]
      +      },
      +      "source": {
      +        "additionalProperties": false,
      +        "properties": {
      +          "agency": {
      +            "type": [
      +              "string",
      +              "null"
      +            ]
      +          },
      +          "database": {
      +            "type": [
      +              "string",
      +              "null"
      +            ]
      +          },
      +          "endpoint": {
      +            "type": [
      +              "string",
      +              "null"
      +            ]
      +          },
      +          "name": {
      +            "type": "string"
      +          }
      +        },
      +        "required": [
      +          "name",
      +          "agency",
      +          "database",
      +          "endpoint"
      +        ],
      +        "type": "object"
      +      },
      +      "source_url": {
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "contract_version",
      +      "source",
      +      "dataset",
      +      "dimension_key",
      +      "data_vintage",
      +      "retrieved_at",
      +      "source_url",
      +      "api_version",
      +      "license",
      +      "citation",
      +      "notices",
      +      "derived",
      +      "derivation_note",
      +      "served_from_cache",
      +      "retrieval",
      +      "field_sources"
      +    ],
      +    "type": "object"
      +  }
      +]
    • changedOutput schema / properties / provenance / description
      Previous value: -"Provenance block (contract v1.1). concise (default): source, source_url, data_vintage, retrieved_at, retrieval, citation, license; detailed: the full canonical block (dataset, dimension_key, notices, served_from_cache, ...). retrieval is the origin diagnostic of this call — requests made to the UIS Data API, attempts including retries, anomalies overcome (timeout, network, rate_limited, http_5xx, http_4xx, malformed_body) and unstable (true when anything had to be retried: treat the figures as obtained with difficulty); null when nothing was fetched from the UIS (catalogue or cached answer)"New value: +"Provenance block of the portfolio. concise (default): source, source_url, data_vintage, retrieved_at, retrieval, citation, license, plus optional keys only when there is something to say (field_sources, notices, derived/derivation_note, revision); detailed: the full canonical block (dataset, dimension_key, notices, served_from_cache, ...). retrieval is the origin diagnostic of this call — requests made to the UIS Data API, attempts including retries, anomalies overcome (timeout, network, rate_limited, http_5xx, http_4xx, malformed_body) and unstable (true when anything had to be retried: treat the figures as obtained with difficulty); null when nothing was fetched from the UIS (catalogue or cached answer)"
  3. Changed1 schema field changedv1.3.1
    • changedOutput schema / properties / provenance / anyOf
      Previous value: -[
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "citation": {
      -        "type": "string"
      -      },
      -      "data_vintage": {
      -        "type": [
      -          "string",
      -          "null"
      -        ]
      -      },
      -      "license": {
      -        "type": [
      -          "string",
      -          "null"
      -        ]
      -      },
      -      "retrieval": {
      -        "anyOf": [
      -          {
      -            "additionalProperties": false,
      -            "properties": {
      -              "anomalies": {
      -                "items": {
      -                  "additionalProperties": false,
      -                  "properties": {
      -                    "count": {
      -                      "maximum": 9007199254740991,
      -                      "minimum": 1,
      -                      "type": "integer"
      -                    },
      -                    "kind": {
      -                      "enum": [
      -                        "timeout",
      -                        "network",
      -                        "http_4xx",
      -                        "http_5xx",
      -                        "rate_limited",
      -                        "malformed_body"
      -                      ],
      -                      "type": "string"
      -                    }
      -                  },
      -                  "required": [
      -                    "kind",
      -                    "count"
      -                  ],
      -                  "type": "object"
      -                },
      -                "type": "array"
      -              },
      -              "attempts": {
      -                "maximum": 9007199254740991,
      -                "minimum": 1,
      -                "type": "integer"
      -              },
      -              "requests": {
      -                "maximum": 9007199254740991,
      -                "minimum": 1,
      -                "type": "integer"
      -              },
      -              "unstable": {
      -                "type": "boolean"
      -              }
      -            },
      -            "required": [
      -              "requests",
      -              "attempts",
      -              "anomalies",
      -              "unstable"
      -            ],
      -            "type": "object"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ]
      -      },
      -      "retrieved_at": {
      -        "type": "string"
      -      },
      -      "source": {
      -        "type": "string"
      -      },
      -      "source_url": {
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "source",
      -      "source_url",
      -      "data_vintage",
      -      "retrieved_at",
      -      "retrieval",
      -      "citation",
      -      "license"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "api_version": {
      -        "type": [
      -          "string",
      -          "null"
      -        ]
      -      },
      -      "citation": {
      -        "type": "string"
      -      },
      -      "contract_version": {
      -        "const": "1.1",
      -        "type": "string"
      -      },
      -      "data_vintage": {
      -        "type": [
      -          "string",
      -          "null"
      -        ]
      -      },
      -      "dataset": {
      -        "additionalProperties": false,
      -        "properties": {
      -          "id": {
      -            "type": [
      -              "string",
      -              "null"
      -            ]
      -          },
      -          "name": {
      -            "type": [
      -              "string",
      -              "null"
      -            ]
      -          },
      -          "version": {
      -            "type": [
      -              "string",
      -              "null"
      -            ]
      -          }
      -        },
      -        "required": [
      -          "id",
      -          "version",
      -          "name"
      -        ],
      -        "type": "object"
      -      },
      -      "derivation_note": {
      -        "type": [
      -          "string",
      -          "null"
      -        ]
      -      },
      -      "derived": {
      -        "type": "boolean"
      -      },
      -      "dimension_key": {
      -        "anyOf": [
      -          {
      -            "additionalProperties": {
      -              "type": "string"
      -            },
      -            "propertyNames": {
      -              "type": "string"
      -            },
      -            "type": "object"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ]
      -      },
      -      "field_sources": {
      -        "anyOf": [
      -          {
      -            "items": {
      -              "additionalProperties": false,
      -              "properties": {
      -                "data_vintage": {
      -                  "type": [
      -                    "string",
      -                    "null"
      -                  ]
      -                },
      -                "dataset_id": {
      -                  "type": [
      -                    "string",
      -                    "null"
      -                  ]
      -                },
      -                "fields": {
      -                  "items": {
      -                    "type": "string"
      -                  },
      -                  "minItems": 1,
      -                  "type": "array"
      -                },
      -                "retrieved_at": {
      -                  "type": [
      -                    "string",
      -                    "null"
      -                  ]
      -                },
      -                "source_url": {
      -                  "type": "string"
      -                }
      -              },
      -              "required": [
      -                "fields",
      -                "source_url",
      -                "dataset_id",
      -                "data_vintage",
      -                "retrieved_at"
      -              ],
      -              "type": "object"
      -            },
      -            "type": "array"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ]
      -      },
      -      "license": {
      -        "additionalProperties": false,
      -        "properties": {
      -          "id": {
      -            "type": [
      -              "string",
      -              "null"
      -            ]
      -          },
      -          "name": {
      -            "type": [
      -              "string",
      -              "null"
      -            ]
      -          },
      -          "terms_url": {
      -            "type": [
      -              "string",
      -              "null"
      -            ]
      -          },
      -          "url": {
      -            "type": [
      -              "string",
      -              "null"
      -            ]
      -          },
      -          "verified_at": {
      -            "type": [
      -              "string",
      -              "null"
      -            ]
      -          }
      -        },
      -        "required": [
      -          "id",
      -          "name",
      -          "url",
      -          "terms_url",
      -          "verified_at"
      -        ],
      -        "type": "object"
      -      },
      -      "notices": {
      -        "items": {
      -          "type": "string"
      -        },
      -        "type": "array"
      -      },
      -      "retrieval": {
      -        "anyOf": [
      -          {
      -            "additionalProperties": false,
      -            "properties": {
      -              "anomalies": {
      -                "items": {
      -                  "additionalProperties": false,
      -                  "properties": {
      -                    "count": {
      -                      "maximum": 9007199254740991,
      -                      "minimum": 1,
      -                      "type": "integer"
      -                    },
      -                    "kind": {
      -                      "enum": [
      -                        "timeout",
      -                        "network",
      -                        "http_4xx",
      -                        "http_5xx",
      -                        "rate_limited",
      -                        "malformed_body"
      -                      ],
      -                      "type": "string"
      -                    }
      -                  },
      -                  "required": [
      -                    "kind",
      -                    "count"
      -                  ],
      -                  "type": "object"
      -                },
      -                "type": "array"
      -              },
      -              "attempts": {
      -                "maximum": 9007199254740991,
      -                "minimum": 1,
      -                "type": "integer"
      -              },
      -              "requests": {
      -                "maximum": 9007199254740991,
      -                "minimum": 1,
      -                "type": "integer"
      -              },
      -              "unstable": {
      -                "type": "boolean"
      -              }
      -            },
      -            "required": [
      -              "requests",
      -              "attempts",
      -              "anomalies",
      -              "unstable"
      -            ],
      -            "type": "object"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ]
      -      },
      -      "retrieved_at": {
      -        "type": "string"
      -      },
      -      "served_from_cache": {
      -        "type": [
      -          "boolean",
      -          "null"
      -        ]
      -      },
      -      "source": {
      -        "additionalProperties": false,
      -        "properties": {
      -          "agency": {
      -            "type": [
      -              "string",
      -              "null"
      -            ]
      -          },
      -          "database": {
      -            "type": [
      -              "string",
      -              "null"
      -            ]
      -          },
      -          "endpoint": {
      -            "type": [
      -              "string",
      -              "null"
      -            ]
      -          },
      -          "name": {
      -            "type": "string"
      -          }
      -        },
      -        "required": [
      -          "name",
      -          "agency",
      -          "database",
      -          "endpoint"
      -        ],
      -        "type": "object"
      -      },
      -      "source_url": {
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "contract_version",
      -      "source",
      -      "dataset",
      -      "dimension_key",
      -      "data_vintage",
      -      "retrieved_at",
      -      "source_url",
      -      "api_version",
      -      "license",
      -      "citation",
      -      "notices",
      -      "derived",
      -      "derivation_note",
      -      "served_from_cache",
      -      "retrieval",
      -      "field_sources"
      -    ],
      -    "type": "object"
      -  }
      -]New value: +[
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "citation": {
      +        "type": "string"
      +      },
      +      "data_vintage": {
      +        "type": [
      +          "string",
      +          "null"
      +        ]
      +      },
      +      "field_sources": {
      +        "items": {
      +          "additionalProperties": false,
      +          "properties": {
      +            "data_vintage": {
      +              "type": [
      +                "string",
      +                "null"
      +              ]
      +            },
      +            "dataset_id": {
      +              "type": [
      +                "string",
      +                "null"
      +              ]
      +            },
      +            "fields": {
      +              "items": {
      +                "type": "string"
      +              },
      +              "minItems": 1,
      +              "type": "array"
      +            },
      +            "retrieved_at": {
      +              "type": [
      +                "string",
      +                "null"
      +              ]
      +            },
      +            "served_from_cache": {
      +              "type": [
      +                "boolean",
      +                "null"
      +              ]
      +            },
      +            "source_url": {
      +              "type": "string"
      +            }
      +          },
      +          "required": [
      +            "fields",
      +            "source_url",
      +            "dataset_id",
      +            "data_vintage",
      +            "retrieved_at"
      +          ],
      +          "type": "object"
      +        },
      +        "minItems": 1,
      +        "type": "array"
      +      },
      +      "license": {
      +        "type": [
      +          "string",
      +          "null"
      +        ]
      +      },
      +      "retrieval": {
      +        "anyOf": [
      +          {
      +            "additionalProperties": false,
      +            "properties": {
      +              "anomalies": {
      +                "items": {
      +                  "additionalProperties": false,
      +                  "properties": {
      +                    "count": {
      +                      "maximum": 9007199254740991,
      +                      "minimum": 1,
      +                      "type": "integer"
      +                    },
      +                    "kind": {
      +                      "enum": [
      +                        "timeout",
      +                        "network",
      +                        "http_4xx",
      +                        "http_5xx",
      +                        "rate_limited",
      +                        "malformed_body"
      +                      ],
      +                      "type": "string"
      +                    }
      +                  },
      +                  "required": [
      +                    "kind",
      +                    "count"
      +                  ],
      +                  "type": "object"
      +                },
      +                "type": "array"
      +              },
      +              "attempts": {
      +                "maximum": 9007199254740991,
      +                "minimum": 1,
      +                "type": "integer"
      +              },
      +              "requests": {
      +                "maximum": 9007199254740991,
      +                "minimum": 1,
      +                "type": "integer"
      +              },
      +              "unstable": {
      +                "type": "boolean"
      +              }
      +            },
      +            "required": [
      +              "requests",
      +              "attempts",
      +              "anomalies",
      +              "unstable"
      +            ],
      +            "type": "object"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ]
      +      },
      +      "retrieved_at": {
      +        "type": "string"
      +      },
      +      "source": {
      +        "type": "string"
      +      },
      +      "source_url": {
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "source",
      +      "source_url",
      +      "data_vintage",
      +      "retrieved_at",
      +      "retrieval",
      +      "citation",
      +      "license"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "api_version": {
      +        "type": [
      +          "string",
      +          "null"
      +        ]
      +      },
      +      "citation": {
      +        "type": "string"
      +      },
      +      "contract_version": {
      +        "enum": [
      +          "1.1",
      +          "1.2"
      +        ],
      +        "type": "string"
      +      },
      +      "data_vintage": {
      +        "type": [
      +          "string",
      +          "null"
      +        ]
      +      },
      +      "dataset": {
      +        "additionalProperties": false,
      +        "properties": {
      +          "id": {
      +            "type": [
      +              "string",
      +              "null"
      +            ]
      +          },
      +          "name": {
      +            "type": [
      +              "string",
      +              "null"
      +            ]
      +          },
      +          "version": {
      +            "type": [
      +              "string",
      +              "null"
      +            ]
      +          }
      +        },
      +        "required": [
      +          "id",
      +          "version",
      +          "name"
      +        ],
      +        "type": "object"
      +      },
      +      "derivation_note": {
      +        "type": [
      +          "string",
      +          "null"
      +        ]
      +      },
      +      "derived": {
      +        "type": "boolean"
      +      },
      +      "dimension_key": {
      +        "anyOf": [
      +          {
      +            "additionalProperties": {
      +              "type": "string"
      +            },
      +            "propertyNames": {
      +              "type": "string"
      +            },
      +            "type": "object"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ]
      +      },
      +      "field_sources": {
      +        "anyOf": [
      +          {
      +            "items": {
      +              "additionalProperties": false,
      +              "properties": {
      +                "data_vintage": {
      +                  "type": [
      +                    "string",
      +                    "null"
      +                  ]
      +                },
      +                "dataset_id": {
      +                  "type": [
      +                    "string",
      +                    "null"
      +                  ]
      +                },
      +                "fields": {
      +                  "items": {
      +                    "type": "string"
      +                  },
      +                  "minItems": 1,
      +                  "type": "array"
      +                },
      +                "retrieved_at": {
      +                  "type": [
      +                    "string",
      +                    "null"
      +                  ]
      +                },
      +                "served_from_cache": {
      +                  "type": [
      +                    "boolean",
      +                    "null"
      +                  ]
      +                },
      +                "source_url": {
      +                  "type": "string"
      +                }
      +              },
      +              "required": [
      +                "fields",
      +                "source_url",
      +                "dataset_id",
      +                "data_vintage",
      +                "retrieved_at"
      +              ],
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ]
      +      },
      +      "license": {
      +        "additionalProperties": false,
      +        "properties": {
      +          "id": {
      +            "type": [
      +              "string",
      +              "null"
      +            ]
      +          },
      +          "name": {
      +            "type": [
      +              "string",
      +              "null"
      +            ]
      +          },
      +          "terms_url": {
      +            "type": [
      +              "string",
      +              "null"
      +            ]
      +          },
      +          "url": {
      +            "type": [
      +              "string",
      +              "null"
      +            ]
      +          },
      +          "verified_at": {
      +            "type": [
      +              "string",
      +              "null"
      +            ]
      +          }
      +        },
      +        "required": [
      +          "id",
      +          "name",
      +          "url",
      +          "terms_url",
      +          "verified_at"
      +        ],
      +        "type": "object"
      +      },
      +      "notices": {
      +        "items": {
      +          "type": "string"
      +        },
      +        "type": "array"
      +      },
      +      "retrieval": {
      +        "anyOf": [
      +          {
      +            "additionalProperties": false,
      +            "properties": {
      +              "anomalies": {
      +                "items": {
      +                  "additionalProperties": false,
      +                  "properties": {
      +                    "count": {
      +                      "maximum": 9007199254740991,
      +                      "minimum": 1,
      +                      "type": "integer"
      +                    },
      +                    "kind": {
      +                      "enum": [
      +                        "timeout",
      +                        "network",
      +                        "http_4xx",
      +                        "http_5xx",
      +                        "rate_limited",
      +                        "malformed_body"
      +                      ],
      +                      "type": "string"
      +                    }
      +                  },
      +                  "required": [
      +                    "kind",
      +                    "count"
      +                  ],
      +                  "type": "object"
      +                },
      +                "type": "array"
      +              },
      +              "attempts": {
      +                "maximum": 9007199254740991,
      +                "minimum": 1,
      +                "type": "integer"
      +              },
      +              "requests": {
      +                "maximum": 9007199254740991,
      +                "minimum": 1,
      +                "type": "integer"
      +              },
      +              "unstable": {
      +                "type": "boolean"
      +              }
      +            },
      +            "required": [
      +              "requests",
      +              "attempts",
      +              "anomalies",
      +              "unstable"
      +            ],
      +            "type": "object"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ]
      +      },
      +      "retrieved_at": {
      +        "type": "string"
      +      },
      +      "served_from_cache": {
      +        "type": [
      +          "boolean",
      +          "null"
      +        ]
      +      },
      +      "source": {
      +        "additionalProperties": false,
      +        "properties": {
      +          "agency": {
      +            "type": [
      +              "string",
      +              "null"
      +            ]
      +          },
      +          "database": {
      +            "type": [
      +              "string",
      +              "null"
      +            ]
      +          },
      +          "endpoint": {
      +            "type": [
      +              "string",
      +              "null"
      +            ]
      +          },
      +          "name": {
      +            "type": "string"
      +          }
      +        },
      +        "required": [
      +          "name",
      +          "agency",
      +          "database",
      +          "endpoint"
      +        ],
      +        "type": "object"
      +      },
      +      "source_url": {
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "contract_version",
      +      "source",
      +      "dataset",
      +      "dimension_key",
      +      "data_vintage",
      +      "retrieved_at",
      +      "source_url",
      +      "api_version",
      +      "license",
      +      "citation",
      +      "notices",
      +      "derived",
      +      "derivation_note",
      +      "served_from_cache",
      +      "retrieval",
      +      "field_sources"
      +    ],
      +    "type": "object"
      +  }
      +]
  4. Changed2 schema fields changedv1.0.1
    • addedOutput schema / properties / provenance / anyOf
      Added value: +[
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "citation": {
      +        "type": "string"
      +      },
      +      "data_vintage": {
      +        "type": [
      +          "string",
      +          "null"
      +        ]
      +      },
      +      "license": {
      +        "type": [
      +          "string",
      +          "null"
      +        ]
      +      },
      +      "retrieval": {
      +        "anyOf": [
      +          {
      +            "additionalProperties": false,
      +            "properties": {
      +              "anomalies": {
      +                "items": {
      +                  "additionalProperties": false,
      +                  "properties": {
      +                    "count": {
      +                      "maximum": 9007199254740991,
      +                      "minimum": 1,
      +                      "type": "integer"
      +                    },
      +                    "kind": {
      +                      "enum": [
      +                        "timeout",
      +                        "network",
      +                        "http_4xx",
      +                        "http_5xx",
      +                        "rate_limited",
      +                        "malformed_body"
      +                      ],
      +                      "type": "string"
      +                    }
      +                  },
      +                  "required": [
      +                    "kind",
      +                    "count"
      +                  ],
      +                  "type": "object"
      +                },
      +                "type": "array"
      +              },
      +              "attempts": {
      +                "maximum": 9007199254740991,
      +                "minimum": 1,
      +                "type": "integer"
      +              },
      +              "requests": {
      +                "maximum": 9007199254740991,
      +                "minimum": 1,
      +                "type": "integer"
      +              },
      +              "unstable": {
      +                "type": "boolean"
      +              }
      +            },
      +            "required": [
      +              "requests",
      +              "attempts",
      +              "anomalies",
      +              "unstable"
      +            ],
      +            "type": "object"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ]
      +      },
      +      "retrieved_at": {
      +        "type": "string"
      +      },
      +      "source": {
      +        "type": "string"
      +      },
      +      "source_url": {
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "source",
      +      "source_url",
      +      "data_vintage",
      +      "retrieved_at",
      +      "retrieval",
      +      "citation",
      +      "license"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "api_version": {
      +        "type": [
      +          "string",
      +          "null"
      +        ]
      +      },
      +      "citation": {
      +        "type": "string"
      +      },
      +      "contract_version": {
      +        "const": "1.1",
      +        "type": "string"
      +      },
      +      "data_vintage": {
      +        "type": [
      +          "string",
      +          "null"
      +        ]
      +      },
      +      "dataset": {
      +        "additionalProperties": false,
      +        "properties": {
      +          "id": {
      +            "type": [
      +              "string",
      +              "null"
      +            ]
      +          },
      +          "name": {
      +            "type": [
      +              "string",
      +              "null"
      +            ]
      +          },
      +          "version": {
      +            "type": [
      +              "string",
      +              "null"
      +            ]
      +          }
      +        },
      +        "required": [
      +          "id",
      +          "version",
      +          "name"
      +        ],
      +        "type": "object"
      +      },
      +      "derivation_note": {
      +        "type": [
      +          "string",
      +          "null"
      +        ]
      +      },
      +      "derived": {
      +        "type": "boolean"
      +      },
      +      "dimension_key": {
      +        "anyOf": [
      +          {
      +            "additionalProperties": {
      +              "type": "string"
      +            },
      +            "propertyNames": {
      +              "type": "string"
      +            },
      +            "type": "object"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ]
      +      },
      +      "field_sources": {
      +        "anyOf": [
      +          {
      +            "items": {
      +              "additionalProperties": false,
      +              "properties": {
      +                "data_vintage": {
      +                  "type": [
      +                    "string",
      +                    "null"
      +                  ]
      +                },
      +                "dataset_id": {
      +                  "type": [
      +                    "string",
      +                    "null"
      +                  ]
      +                },
      +                "fields": {
      +                  "items": {
      +                    "type": "string"
      +                  },
      +                  "minItems": 1,
      +                  "type": "array"
      +                },
      +                "retrieved_at": {
      +                  "type": [
      +                    "string",
      +                    "null"
      +                  ]
      +                },
      +                "source_url": {
      +                  "type": "string"
      +                }
      +              },
      +              "required": [
      +                "fields",
      +                "source_url",
      +                "dataset_id",
      +                "data_vintage",
      +                "retrieved_at"
      +              ],
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ]
      +      },
      +      "license": {
      +        "additionalProperties": false,
      +        "properties": {
      +          "id": {
      +            "type": [
      +              "string",
      +              "null"
      +            ]
      +          },
      +          "name": {
      +            "type": [
      +              "string",
      +              "null"
      +            ]
      +          },
      +          "terms_url": {
      +            "type": [
      +              "string",
      +              "null"
      +            ]
      +          },
      +          "url": {
      +            "type": [
      +              "string",
      +              "null"
      +            ]
      +          },
      +          "verified_at": {
      +            "type": [
      +              "string",
      +              "null"
      +            ]
      +          }
      +        },
      +        "required": [
      +          "id",
      +          "name",
      +          "url",
      +          "terms_url",
      +          "verified_at"
      +        ],
      +        "type": "object"
      +      },
      +      "notices": {
      +        "items": {
      +          "type": "string"
      +        },
      +        "type": "array"
      +      },
      +      "retrieval": {
      +        "anyOf": [
      +          {
      +            "additionalProperties": false,
      +            "properties": {
      +              "anomalies": {
      +                "items": {
      +                  "additionalProperties": false,
      +                  "properties": {
      +                    "count": {
      +                      "maximum": 9007199254740991,
      +                      "minimum": 1,
      +                      "type": "integer"
      +                    },
      +                    "kind": {
      +                      "enum": [
      +                        "timeout",
      +                        "network",
      +                        "http_4xx",
      +                        "http_5xx",
      +                        "rate_limited",
      +                        "malformed_body"
      +                      ],
      +                      "type": "string"
      +                    }
      +                  },
      +                  "required": [
      +                    "kind",
      +                    "count"
      +                  ],
      +                  "type": "object"
      +                },
      +                "type": "array"
      +              },
      +              "attempts": {
      +                "maximum": 9007199254740991,
      +                "minimum": 1,
      +                "type": "integer"
      +              },
      +              "requests": {
      +                "maximum": 9007199254740991,
      +                "minimum": 1,
      +                "type": "integer"
      +              },
      +              "unstable": {
      +                "type": "boolean"
      +              }
      +            },
      +            "required": [
      +              "requests",
      +              "attempts",
      +              "anomalies",
      +              "unstable"
      +            ],
      +            "type": "object"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ]
      +      },
      +      "retrieved_at": {
      +        "type": "string"
      +      },
      +      "served_from_cache": {
      +        "type": [
      +          "boolean",
      +          "null"
      +        ]
      +      },
      +      "source": {
      +        "additionalProperties": false,
      +        "properties": {
      +          "agency": {
      +            "type": [
      +              "string",
      +              "null"
      +            ]
      +          },
      +          "database": {
      +            "type": [
      +              "string",
      +              "null"
      +            ]
      +          },
      +          "endpoint": {
      +            "type": [
      +              "string",
      +              "null"
      +            ]
      +          },
      +          "name": {
      +            "type": "string"
      +          }
      +        },
      +        "required": [
      +          "name",
      +          "agency",
      +          "database",
      +          "endpoint"
      +        ],
      +        "type": "object"
      +      },
      +      "source_url": {
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "contract_version",
      +      "source",
      +      "dataset",
      +      "dimension_key",
      +      "data_vintage",
      +      "retrieved_at",
      +      "source_url",
      +      "api_version",
      +      "license",
      +      "citation",
      +      "notices",
      +      "derived",
      +      "derivation_note",
      +      "served_from_cache",
      +      "retrieval",
      +      "field_sources"
      +    ],
      +    "type": "object"
      +  }
      +]
    • addedOutput schema / properties / provenance / description
      Added value: +"Provenance block (contract v1.1). concise (default): source, source_url, data_vintage, retrieved_at, retrieval, citation, license; detailed: the full canonical block (dataset, dimension_key, notices, served_from_cache, ...). retrieval is the origin diagnostic of this call — requests made to the UIS Data API, attempts including retries, anomalies overcome (timeout, network, rate_limited, http_5xx, http_4xx, malformed_body) and unstable (true when anything had to be retried: treat the figures as obtained with difficulty); null when nothing was fetched from the UIS (catalogue or cached answer)"
  5. First observedv0.4.0

TDQS

A4.3/5.0
Behavior3/5

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

Annotations already declare readOnly/idempotent/non-destructive/openWorld=false, but the description adds genuinely non-obvious behavior: everyday and US wording is silently resolved to UIS terms (enrollment→enrolment, spending→expenditure) with the substitution disclosed in vocabulary_notes. That is valuable transparency an agent could not infer from any structured field.

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?

Dense but every sentence carries information: scope first, query mechanics, synonym resolution, return contents, then boundaries. No redundancy despite the length.

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 and the description still pre-announces what matters for chaining — indicator codes for uis_get_data, data availability (years, record count), and vocabulary_notes. Nothing an agent needs to call or follow up on 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 coverage is 100% and enum values for theme and provenance_mode are fully documented in the schema, so the description adds little: it restates the AND/case-insensitive matching already in the query parameter's description. limit, offset and provenance_mode semantics are left entirely to the schema — appropriate, but no added value.

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?

Specific verb+resource with scope (~5,000 indicators across education, science/R&D, culture and communication) and clear differentiation from siblings: it searches the catalogue but returns no statistical values, and ILO labour data belongs to the ILOSTAT server. An agent can immediately tell this apart from uis_get_data.

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 routing: 'use uis_get_data' for values, ILOSTAT for labour statistics. Adds concrete query strategy — start with 2–3 words, drop terms on zero results — and states all terms are AND-matched and case-insensitive.

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