Odos MCP

🚀 Odos MCP 客戶端

Odos MCP 客戶端是一個模型上下文協議（MCP）客戶端，用於與 Odos DEX 聚合平臺和 Zerion 投資組合分析工具進行交互。該工具可全面訪問多個區塊鏈網絡的 DeFi 交易數據、兌換報價、投資組合分析和交易歷史。

🚀 快速開始

請確保你已完成以下步驟來設置和運行 Odos MCP 客戶端：

1. 安裝依賴：按照安裝指南中的步驟克隆倉庫、創建虛擬環境並安裝所需依賴。
2. 配置環境變量：設置 ZERION_API_KEY 環境變量，以便使用 Zerion 分析工具。
3. 驗證設置：運行驗證腳本 python scripts/verify_setup.py 確保一切配置正確。
4. 啟動 MCP 服務器：運行 poetry run python -m src.client.server 啟動服務器。

✨ 主要特性

Odos API 集成

• 兌換報價：獲取跨 DEX 流動性來源的最優兌換路線和價格。
• Zap 操作：單交易流動性提供報價。
• 鏈支持：訪問所有 Odos 支持的區塊鏈網絡。
• 代幣數據：獲取支持代幣的實時價格和元數據。
• 路由器信息：獲取合約地址和區塊鏈基礎設施詳情。

Zerion 分析

• 投資組合分析：提供完整的錢包持有量和組成明細。
• 交易歷史：提供詳細的歷史交易數據和分析。
• 績效跟蹤：跟蹤歷史投資組合績效和回報。
• 燃氣價格監控：實時監控各網絡的燃氣價格估算。

📦 安裝指南

# 克隆倉庫
git clone <repository-url>
cd odos-mcp

# 創建並激活虛擬環境
python -m venv .venv
source .venv/bin/activate  # 在 Windows 上使用: .venv\Scripts\activate

# 安裝依賴
pip install -r requirements.txt

# 設置環境變量
# 創建 .env 文件並添加你的 API 密鑰（請參閱配置部分）
# 或者直接設置環境變量：
export ZERION_API_KEY="your_zerion_api_key_here"

# 驗證設置（可選但推薦）
python scripts/verify_setup.py

💻 使用示例

基礎用法

確保你已設置所需的環境變量（請參閱配置部分），然後啟動 MCP 服務器：

poetry run python -m src.client.server

注意：如果你計劃使用任何 Zerion 分析工具，請確保已設置 ZERION_API_KEY。

驗證設置

運行驗證腳本以確保一切配置正確：

python scripts/verify_setup.py

此腳本將執行以下操作：

• 測試所有模塊導入
• 驗證環境配置
• 檢查 API 連接性
• 驗證輔助函數
• 提供全面的設置報告

📚 詳細文檔

可用工具

API 工具 (src/client/tools/api/)

Zerion 工具 (src/client/tools/zerion/)

注意：這些工具需要設置 ZERION_API_KEY 環境變量。

項目結構

odos-mcp/
├── src/client/                 # 核心客戶端包
│   ├── tools/                  # 工具實現
│   │   ├── api/               # Odos API 工具
│   │   └── zerion/            # Zerion 集成工具
│   ├── constants.py           # 鏈 ID、代幣地址、API 端點
│   ├── helpers.py             # API 請求的實用函數
│   ├── mcp_types.py          # API 響應的 Pydantic 模型
│   └── api_models.py         # 其他數據模型
├── scripts/                   # 開發和維護腳本
│   ├── verify_setup.py        # 設置驗證腳本
│   └── ...
├── tests/                     # 測試套件
└── requirements.txt          # Python 依賴項

配置

環境變量

客戶端需要以下環境變量：

# 必需：用於投資組合分析的 Zerion API 密鑰
export ZERION_API_KEY="your_zerion_api_key_here"

獲取 API 密鑰

Zerion API 密鑰

要使用 Zerion 分析工具，你需要一個 Zerion API 密鑰：

1. 訪問 Zerion 開發者門戶
2. 註冊開發者賬戶
3. 創建新的 API 密鑰
4. 設置 ZERION_API_KEY 環境變量

設置環境變量

在項目根目錄下創建 .env 文件：

# .env 文件
ZERION_API_KEY=your_zerion_api_key_here

或者直接在 shell 中設置：

export ZERION_API_KEY="your_zerion_api_key_here"

API 端點

以下 API 端點在應用程序中硬編碼：

• Odos API：https://api.odos.xyz（無需身份驗證）
• Zerion API：https://api.zerion.io（需要 API 密鑰）

開發

設置開發環境

# 安裝開發依賴
pip install -r requirements-dev.txt

# 運行格式化
python scripts/format.py

# 運行測試

添加新工具

1. 在適當的目錄（api/ 或 zerion/）中創建工具文件。
2. 添加簡要的描述文檔字符串。
3. 使用 FastMCP 裝飾器模式實現。
4. 更新 __init__.py 導出。
5. 在 tests/ 目錄中添加測試。

貢獻

1. 分叉倉庫
2. 創建功能分支 (git checkout -b feature/amazing-feature)
3. 提交更改 (git commit -m 'Add amazing feature')
4. 推送到分支 (git push origin feature/amazing-feature)
5. 打開拉取請求

📄 許可證

本項目採用 MIT 許可證 - 詳情請參閱 LICENSE 文件。

🛠️ 支持

如果你有任何問題或遇到問題，請：

• 在倉庫中創建問題
• 查看現有文檔和工具描述
• 查看 Odos API 文檔以獲取參數詳情