list_editions

Pack: uk-ons · Endpoint: https://gateway.pipeworx.io/uk-ons/mcp

List all named editions of an ONS dataset (e.g., “time-series”, “annual”). Returns each edition label, release date, state, and the latest version ID to use with get_version or get_observations.

Parameters

NameTypeRequiredDescription
dataset_idstringyesONS dataset ID

Example call

Arguments

{
  "dataset_id": "cpih01"
}

curl

curl -X POST https://gateway.pipeworx.io/uk-ons/mcp \
  -H 'Content-Type: application/json' \
  -d '{"jsonrpc":"2.0","id":1,"method":"tools/call","params":{"name":"list_editions","arguments":{"dataset_id":"cpih01"}}}'

TypeScript (@pipeworx/sdk)

import { Pipeworx } from '@pipeworx/sdk';
const pipeworx = new Pipeworx();

const result = await pipeworx.call('list_editions', {
  "dataset_id": "cpih01"
});

Response shape

Always returns: dataset_id, total, editions

FieldTypeDescription
dataset_idstringDataset ID
totalintegerTotal number of editions
editionsarrayList of editions
Full JSON Schema
{
  "type": "object",
  "properties": {
    "dataset_id": {
      "type": "string",
      "description": "Dataset ID"
    },
    "total": {
      "type": "integer",
      "description": "Total number of editions"
    },
    "editions": {
      "type": "array",
      "description": "List of editions",
      "items": {
        "type": "object",
        "properties": {
          "edition": {
            "type": [
              "string",
              "null"
            ],
            "description": "Edition label"
          },
          "release_date": {
            "type": [
              "string",
              "null"
            ],
            "description": "Release date"
          },
          "state": {
            "type": [
              "string",
              "null"
            ],
            "description": "Edition state"
          },
          "latest_version_id": {
            "type": [
              "string",
              "null"
            ],
            "description": "ID of the latest version for this edition"
          }
        }
      }
    }
  },
  "required": [
    "dataset_id",
    "total",
    "editions"
  ]
}

Connect

Add this to your MCP client config, or use one-click install buttons:

{
  "mcpServers": {
    "uk-ons": {
      "url": "https://gateway.pipeworx.io/uk-ons/mcp"
    }
  }
}

See Getting Started for client-specific install steps.

Regenerated from source · build July 6, 2026