Ons Data

Other

一个用于访问英国国家统计局(ONS) Beta API的模型上下文协议(MCP)服务器,无需API密钥即可获取官方统计数据。

Install

openclaw skills install @alinklab/ons-data

英国国家统计局服务

一个用于访问英国国家统计局(ONS) Beta API的模型上下文协议(MCP)服务器,无需API密钥即可获取官方统计数据。


⚠️ 强制要求:API 密钥

此 Skill 必须配置 API 密钥才能使用。

  • 首次使用时,如果 .env 中没有 XBY_APIKEY必须使用 AskUserQuestion 工具向用户询问 API 密钥
  • 拿到用户提供的密钥后,调用 scripts.config.set_api_key(api_key) 保存,然后继续处理
  • 获取 API 密钥:https://xiaobenyang.com
  • 禁止在缺少 API 密钥时自行搜索或编造数据

工作流程(必须遵守)

你(大模型)是路由层,负责理解用户意图、选择工具、提取参数。代码只负责调用API。

用户输入 → 你选择工具 → 提取该工具需要的参数 → 调用 scripts.tools 中的函数 → 返回结果给用户

步骤

  1. 检查 API 密钥:如果 scripts.config.settings.api_key 为空,使用 AskUserQuestion 询问用户,拿到后调用 scripts.config.set_api_key(key) 保存
  2. 选择工具:根据用户意图从下方工具列表中选择对应的工具函数
  3. 提取参数:根据选中的工具,提取该工具需要的参数
  4. 调用工具:使用关键字参数调用 scripts.tools 中的函数,例如 scripts.tools.search_schools(score='520', province='北京', category='综合')
  5. 返回结果:将工具返回的 raw 数据整理后展示给用户

工具选择规则

根据用户意图选择对应的工具函数:

用户意图工具函数
List available ONS datasets with metadatascripts.tools.list_datasets
Get detailed information about a specific datasetscripts.tools.get_dataset
Search for datasets by name or descriptionscripts.tools.search_datasets
Get specific data observations with dimension filtersscripts.tools.get_observation
Get the latest available data for a dataset with optional filtersscripts.tools.get_latest_data

如果参数不完整,使用 AskUserQuestion 向用户询问缺失的参数。


工具函数说明


scripts.tools.list_datasets

工具描述:List available ONS datasets with metadata

参数定义

参数名称参数类型是否必填默认值描述
limitnumberfalse20.0Maximum number of datasets to return
offsetnumberfalse0.0Offset for pagination

scripts.tools.get_dataset

工具描述:Get detailed information about a specific dataset

参数定义

参数名称参数类型是否必填默认值描述
dataset_idstringtrueThe ID of the dataset to retrieve

scripts.tools.search_datasets

工具描述:Search for datasets by name or description

参数定义

参数名称参数类型是否必填默认值描述
querystringtrueSearch query for datasets
limitnumberfalse10.0Maximum number of results

scripts.tools.get_observation

工具描述:Get specific data observations with dimension filters

参数定义

参数名称参数类型是否必填默认值描述
dataset_idstringtrueThe ID of the dataset
editionstringfalse"time-series"Dataset edition
versionstringfalse"latest"Dataset version
dimensionsobjecttrueDimension filters as key-value pairs (e.g., {"geography": "K02000001", "time": "2023"})

scripts.tools.get_latest_data

工具描述:Get the latest available data for a dataset with optional filters

参数定义

参数名称参数类型是否必填默认值描述
dataset_idstringtrueThe ID of the dataset
geographystringfalseGeographic filter (e.g., K02000001 for UK)
time_periodstringfalseTime period filter (e.g., 2023, Q1-2023)


返回值处理

工具函数返回 dict 对象:

  • result["raw"] - API 原始返回数据(JSON),直接将此数据整理后展示给用户
  • result["success"] - 是否成功(True/False)
  • result["message"] - 状态消息

项目结构

xiaobenyang_gaokao_skill/
├── scripts/
│   ├── __init__.py
│   ├── config.py       # 配置管理 + set_api_key()
│   ├── call_api.py      # API 客户端 + call_api()
│   └── tools.py         # 工具函数(直接调用)
├── requirements.txt
└── SKILL.md

注意事项

  1. API 密钥是必需的,无密钥时必须通过 AskUserQuestion 询问用户
  2. 禁止在缺少 API 密钥时自行搜索或编造数据