在构建需要访问特定外部数据的智能体时,直接通过 API 或网页爬取往往效率低下。针对香港政府官方开放数据门户 DATA.GOV.HK 的访问需求,这里介绍 DeepSeek Harness (DSH) 插件 xby-open-data-hk。
插件介绍¶
该插件是一个 MCP 服务器,由 xby-skill 维护,旨在简化对 DATA.GOV.HK 的数据集、分类及格式信息的查询。它封装了数据集列表、详情查询、分类检索及格式筛选等核心功能,支持多语言(简体、繁体、英文)。
安装与启用¶
安装该插件需要管理员权限,且安装前建议检查源码与许可证(MIT)。
dsh plugin --profile web add github:xby_skill/xby-open-data-hk
核心功能¶
1. 认证与密钥管理¶
- set_xby_apikey:在聊天上下文中设置 API 密钥。密钥设置后会自动持久化,重启进程后依然有效。
2. 数据集查询¶
- list_datasets:获取数据集 ID 列表。
- 支持参数:
limit(默认 1000),offset,language(en, tc, sc)。
- 支持参数:
- get_dataset_details:获取特定数据集的详细信息。
- 支持参数:
dataset_id,language,include_tracking。
- 支持参数:
- search_datasets:通过查询词搜索数据集。
- 基于包搜索 API,搜索标题、描述等元数据。
- 限制:默认 limit 为 10,最大为 1000。
- 支持参数:
query(Solr 查询字符串),limit,offset,language。
- get_datasets_by_format:获取特定文件格式的数据集。
- 支持参数:
file_format(如 CSV, JSON, GeoJSON),limit,language。
- 支持参数:
3. 分类与面元搜索¶
- list_categories:获取数据类别(组)列表。
- 支持参数:
sort(如 ‘name asc’, ‘package_count desc’),limit,offset,language。
- 支持参数:
- get_category_details:获取特定类别的详细信息。
- 支持参数:
category_id,include_datasets,include_dataset_count等。
- 支持参数:
- search_datasets_with_facets:搜索数据集并返回面元结果,便于探索。
- 支持参数:
query,language。
- 支持参数:
4. 辅助功能¶
- get_supported_formats:获取 DATA.GOV.HK 支持的文件格式列表。
配置与使用¶
获取 API 密钥¶
使用该插件前,需前往小笨羊官网注册并获取 API 密钥。设置密钥后,后续的数据查询请求将使用该凭证。
典型用法示例¶
设置密钥
在聊天中输入设置命令,以启用 API 访问。
列出数据集
获取前 10 个数据集 ID,语言设置为英文。
{
"limit": 10,
"offset": 0,
"language": "en"
}
搜索数据集
搜索包含 “transport” 关键词的数据集。
{
"query": "transport",
"language": "sc"
}
获取特定格式数据集
查找所有 CSV 格式的数据集。
{
"file_format": "CSV",
"language": "tc"
}
适用场景与注意事项¶
- 适用场景:适用于需要分析香港公共数据(如交通、天气、统计等)的智能体开发,或需要从 DATA.GOV.HK 动态获取结构化数据的自动化脚本。
- 运行权限:插件以当前 DSH 进程的权限运行。
- 注意事项:
list_datasets默认返回 1000 条记录,search_datasets默认返回 10 条。- 支持的语言代码包括
en(英文)、tc(繁体中文)、sc(简体中文)。 - 使用前请务必阅读 GitHub 源码,确保符合项目的使用规范。
总结¶
xby-open-data-hk 提供了一套标准化的接口来访问香港政府开放数据。对于开发者而言,这避免了手动解析网页或处理复杂的 API 请求细节,能够更专注于业务逻辑的实现。