Abs

🚀 ABS 數據流協議 (MCP) 服務器

本項目是一個 MCP（模型上下文協議）服務器，可提供對澳大利亞統計局（ABS）數據 API 的訪問。藉助該服務器，AI 助手能夠通過 SDMX - ML API 查詢並分析 ABS 統計數據，為數據的獲取與處理提供了便捷途徑。

🚀 快速開始

本服務器可讓 AI 助手通過 SDMX - ML API 對 ABS 統計數據進行查詢和分析。以下是使用前的安裝與運行步驟。

✨ 主要特性

• 🔍 可通過 SDMX - ML API 動態發現所有可用的 ABS 數據集。
• 🎯 支持使用可選過濾器查詢 ABS 數據集。
• 📊 支持多種數據格式，如 JSON、CSV、XML。
• 🤝 基於 MCP 協議實現與 AI 助手的無縫集成。
• ⚡ 具備緩存系統，可有效提高性能。
• 📝 擁有全面的日誌記錄和錯誤處理機制。

📦 安裝指南

在項目根目錄下，執行以下命令進行依賴安裝：

npm install

💻 使用示例

開發環境使用

先決條件

• 需要 Node.js 18 或更高版本。
• 需要 npm 8 或更高版本。

構建項目

npm run build

運行服務器

npm start

開發工具

• npm run build：用於構建 TypeScript 代碼。
• npm start：用於運行服務器。
• npm run inspector：運行 MCP 檢查器以進行測試。

📚 詳細文檔

項目結構

src/
├── index.ts                # 主服務器實現文件
├── services/
│   └── abs/
│       ├── ABSApiClient.ts # ABS API 通信類
│       └── DataFlowService.ts # 數據流管理與緩存服務類
├── types/
│   └── abs.ts             # TypeScript 類型定義
└── utils/
    └── logger.ts          # 日誌記錄配置

與Claude Desktop集成

1. 關閉正在運行的 Claude Desktop。
2. 啟動 ABS MCP 服務器：npm start。
3. 啟動 Claude Desktop。
4. ABS 工具應在“可用 MCP 工具”窗口中出現。

API 文檔

有關 ABS 數據 API 的更多信息，可參考以下文檔：

• SDMX - ML 文檔
• ABS API 文檔

貢獻方式

1. 叉取倉庫。
2. 創建功能分支。
3. 進行修改。
4. 提交拉取請求。

🔧 技術細節

ABS API 客戶端

ABSApiClient 類負責處理與 ABS 數據 API 的通信，具體特性如下：

• 使用 SDMX - ML 格式進行數據交換。
• 支持多種響應格式（JSON、CSV、XML）。
• 實現了錯誤處理和日誌記錄。
• 配置了超時時間和重試機制。

數據流服務

DataFlowService 類用於管理 ABS 數據流，具備以下功能：

• 動態從 ABS API 獲取可用的數據集。
• 實現緩存功能，支持配置刷新間隔。
• 提供查詢特定數據集的方法。
• 處理數據轉換和格式化。

日誌記錄

使用 Winston 的全面日誌系統，具有以下特點：

• 為開發提供調試級別的日誌。
• 採用結構化的 JSON 格式日誌。
• 支持控制檯和文件傳輸選項。
• 可配置的日誌級別和格式。

📄 許可證

本項目採用 MIT 許可證。