在構建需要訪問特定外部數據的智能體時,直接通過 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 請求細節,能夠更專注於業務邏輯的實現。