Skip to main content
Glama
SidneyBissoli

UNESCO UIS Education Statistics MCP

Get UNESCO UIS data

uis_get_data
Read-onlyIdempotent

Retrieve raw UIS statistical records filtered by indicator codes, geographic units, and year range for education, science, and culture analysis; optionally include per-record source footnotes.

Instructions

Statistical records from the UNESCO Institute for Statistics Data API, filtered by indicator codes (from uis_search_indicators, up to 25), geo unit codes (from uis_list_geo_units) and year range. Set include_footnotes for per-record source notes. Returns raw UIS records only — it does not aggregate, convert or otherwise transform values; ILO labour statistics live in the sibling ILOSTAT MCP server. Broad queries are rejected with the record count — narrow by geo unit or years. A code that does not exist is an error carrying the UIS API's own wording, never an empty result: zero rows means the codes are real and the selection has no data, and the hint then relays what the UIS reported (including the indicator's available year range). When only SOME of the requested codes exist, the matching rows are returned with warnings naming the rest. Values are those of the release named in data_vintage: a new UIS release can revise past years. On a record, magnitude says what the value shown means (e.g. NA = not applicable, shown as 0; SUPP = withheld, blank) and qualifier says how it was obtained (national or UIS estimate); the provenance notices count them in plain words; both are null when the UIS publishes no flag. The UIS publishes no unit field: the unit usually closes the indicator name in parentheses ("(%)", "(number)", "(years)"), but not always — a parenthesis can also name a parity index (GPIA), an estimate type or an education level, and some names have none.

Input Schema

NameRequiredDescriptionDefault
end_yearNoLast year, e.g. 2024
geo_unitsNoGeo unit codes from uis_list_geo_units (e.g. ["BRA","ARG"]); omit for all
indicatorsYesIndicator codes from uis_search_indicators (e.g. ["CR.1"])
start_yearNoFirst year, e.g. 2015
provenance_modeNoProvenance verbosity: 'concise' (default — source, url, vintage, retrieval date, citation, license) or 'detailed' (full canonical block with dataset, dimension key and notices)
include_footnotesNoInclude per-record footnotes (source notes); default false

Output Schema

NameRequiredDescriptionDefault
rowsYesRaw UIS records, one per indicator, geo unit and year; value is untransformed
columnsYesCore fields of each row, in reading order
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)
rows_countYesNumber of records returned
attributionYesSource URLs the figures came from (the provenance source_url of each block), for linking the citation

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 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 / columns / description
      Added value: +"Core fields of each row, in reading order"
    • addedOutput schema / properties / rows / description
      Added value: +"Raw UIS records, one per indicator, geo unit and year; value is untransformed"
    • addedOutput schema / properties / rows_count / description
      Added value: +"Number of records returned"
  2. Changed3 schema fields changedv1.8.0
    • addedOutput schema / properties / rows / items / properties
      Added value: +{
      +  "geo_unit": {
      +    "type": "string"
      +  },
      +  "indicator": {
      +    "type": "string"
      +  },
      +  "magnitude": {
      +    "type": [
      +      "string",
      +      "null"
      +    ]
      +  },
      +  "qualifier": {
      +    "type": [
      +      "string",
      +      "null"
      +    ]
      +  },
      +  "value": {
      +    "type": [
      +      "number",
      +      "null"
      +    ]
      +  },
      +  "year": {
      +    "type": "number"
      +  }
      +}
    • removedOutput schema / properties / rows / items / propertyNames
      Removed value: -{
      -  "type": "string"
      -}
    • addedOutput schema / properties / rows / items / required
      Added value: +[
      +  "indicator",
      +  "geo_unit",
      +  "year",
      +  "value",
      +  "magnitude",
      +  "qualifier"
      +]
  3. 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)"
  4. 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"
      +  }
      +]
  5. 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)"
  6. First observedv0.4.0

TDQS

A4.2/5.0
Behavior5/5

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

Annotations already declare read-only, idempotent, open-world, non-destructive; the description goes well beyond by disclosing rejection behavior for broad queries, error-vs-empty-result semantics ('a code that does not exist is an error... zero rows means the codes are real'), partial-match warnings, release revision risk via data_vintage, and how magnitude/qualifier flags render. This is exactly the extra context annotations cannot carry.

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 source and filtering scope are correctly front-loaded, but the text is a single very dense paragraph of roughly 300 words mixing invocation rules, error semantics and output-flag interpretation. Much of the magnitude/qualifier and unit-parenthesis material belongs to return-value documentation (and an output schema exists), so it dilutes the call-critical content.

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 6-parameter filtered-read tool with full annotation coverage and an output schema, the definition covers invocation constraints, failure modes and provenance well. It is arguably over-complete on rendered-value semantics that the output schema may already describe, but nothing an agent needs in order to call it correctly is missing.

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

Parameters3/5

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

Schema description coverage is 100%, so all six parameters are already documented in the schema. The description reinforces the code-source provenance for indicators and geo_units and explains include_footnotes' purpose, but adds no syntax or format detail beyond what the schema states; baseline 3 applies.

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?

Opens with a specific verb+resource ('Statistical records from the UNESCO Institute for Statistics Data API') and enumerates the filtering dimensions (indicator codes, geo unit codes, year range). It also draws a clear boundary against the ILOSTAT MCP server for labour statistics, so an agent can distinguish it from both code-lookup siblings and the non-UIS alternative.

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

Usage Guidelines4/5

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

Gives concrete operating guidance: codes must come from uis_search_indicators / uis_list_geo_units, broad queries are rejected so narrow by geo unit or years, and it states it does not aggregate or transform values, with ILO labour data explicitly out of scope. Lacks an explicit 'use fetch/search instead when...' routing statement, so not a full 5.

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