使用说明
Odos MCP客户端
模型上下文协议(MCP)客户端,用于与Odoo DEX聚合平台和Zerion投资组合分析进行交互。该工具提供对DeFi交易数据、掉期报价、投资组合分析和跨多个区块链网络的交易历史的全面访问。
特性
Odos API集成
- 交换报价:获得跨DEX流动性来源的最佳掉期路线和定价
- Zap操作:单笔交易流动性准备金报价
- 链支持:访问所有支持Odoo的区块链网络
- 令牌数据:支持的代币的实时定价和元数据
- 路由器信息:合同地址和区块链基础设施详细信息
Zerion分析
- 投资组合分析:完整的钱包持有量和构成明细
- 交易历史记录:详细的历史交易数据和分析
- 性能跟踪:历史投资组合业绩和回报
- 天然气价格监测:跨网络的实时天然气估算
安装
# Clone the repository
git clone <repository-url>
cd odos-mcp
# Create and activate virtual environment
python -m venv .venv
source .venv/bin/activate # On Windows: .venv\Scripts\activate
# Install dependencies
pip install -r requirements.txt
# Set up environment variables
# Create a .env file and add your API keys (see Configuration section)
# Or set environment variables directly:
export ZERION_API_KEY="your_zerion_api_key_here"
# Verify setup (optional but recommended)
python scripts/verify_setup.py
用法
确保您已设置所需的环境变量(请参阅配置部分),然后启动MCP服务器:
poetry run python -m src.client.server
备注:确保 ZERION_API_KEY 如果您计划使用任何Zerion分析工具,则设置为。
验证您的设置
运行验证脚本以确保所有配置正确:
python scripts/verify_setup.py
此脚本将:
- 测试所有模块导入
- 验证环境配置
- 检查API连接
- 验证辅助函数
- 提供全面的设置报告
可用工具
API工具(src/client/tools/api/)
| 工具 | 说明 |
|---|---|
get_quote_swap |
获取掉期报价和交易数据 |
get_quote_zap |
获取流动性供应的zap报价 |
get_supported_chains |
列出支持的区块链网络 |
get_supported_tokens |
按链检索可交易代币 |
get_token_price |
实时代币定价数据 |
get_chain_token_prices |
跨链批量代币价格 |
get_currencies |
法定货币汇率 |
get_contract_info |
智能合约详细信息和元数据 |
get_router_address |
Odoo路由器合同地址 |
get_current_block |
当前块号和网络状态 |
get_liquidity_sources |
可用的DEX集成 |
Zerion工具(src/client/tools/zerion/)
备注:这些工具需要 ZERION_API_KEY 要设置的环境变量。
| 工具 | 说明 |
|---|---|
get_wallet_portfolio |
投资组合持有量和构成 |
get_past_transactions |
历史交易分析 |
get_past_performance |
投资组合绩效跟踪 |
get_gas_prices |
网络天然气价格估算 |
项目结构
odos-mcp/
├── src/client/ # Core client package
│ ├── tools/ # Tool implementations
│ │ ├── api/ # Odos API tools
│ │ └── zerion/ # Zerion integration tools
│ ├── constants.py # Chain IDs, token addresses, API endpoints
│ ├── helpers.py # Utility functions for API requests
│ ├── mcp_types.py # Pydantic models for API responses
│ └── api_models.py # Additional data models
├── scripts/ # Development and maintenance scripts
│ ├── verify_setup.py # Setup verification script
│ └── ...
├── tests/ # Test suite
└── requirements.txt # Python dependencies
配置
环境变量
客户端需要以下环境变量:
# Required: Zerion API Key for portfolio analytics
export ZERION_API_KEY="your_zerion_api_key_here"
获取API密钥
Zerion API密钥
要使用Zerion分析工具,您需要Zerion API密钥:
- 访问 Zerion开发者门户
- 注册开发人员帐户
- 创建新的API密钥
- 设置
ZERION_API_KEY环境变量
设置环境变量
创建一个 .env 项目根目录中的文件:
# .env file
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(无需身份验证) - API Zerion:
https://api.zerion.io(需要API密钥)
发展
设置开发环境
# Install development dependencies
pip install -r requirements-dev.txt
# Run formatting
python scripts/format.py
# Run tests
添加新工具
- 在适当的目录中创建工具文件(
api/或zerion/) - 添加简要描述文档字符串
- 使用FastMCP装饰器模式实现
- 更新
__init__.py出口 - 在中添加测试
tests/目录
贡献
- 复刻仓库
- 创建特征分支(
git checkout -b feature/amazing-feature) - 提交更改(
git commit -m 'Add amazing feature') - 推送到分支(
git push origin feature/amazing-feature) - 打开拉取请求
许可证
此项目根据MIT许可证获得许可-有关详细信息,请参阅许可证文件。
支持
如有疑问或问题:
- 在存储库中创建问题
- 检查现有文档和工具说明
- 查看Odos API文档以了解参数详细信息