Odos MCP

🚀 Odos MCP Client

A Model Context Protocol (MCP) client for interacting with the Odos DEX aggregation platform and Zerion portfolio analytics. It offers comprehensive access to DeFi trading data, swap quotes, portfolio analysis, and transaction history across multiple blockchain networks.

✨ Features

Odos API Integration

• Swap Quotes: Obtain optimal swap routes and pricing across DEX liquidity sources.
• Zap Operations: Receive single - transaction liquidity provision quotes.
• Chain Support: Access all blockchain networks supported by Odos.
• Token Data: Get real - time pricing and metadata for supported tokens.
• Router Information: Retrieve contract addresses and blockchain infrastructure details.

Zerion Analytics

• Portfolio Analysis: Get a complete breakdown of wallet holdings and composition.
• Transaction History: Access detailed historical transaction data and analysis.
• Performance Tracking: Monitor historical portfolio performance and returns.
• Gas Price Monitoring: Get real - time gas estimates across networks.

📦 Installation

# 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

💻 Usage Examples

Basic Usage

Ensure you have set up the required environment variables (see Configuration section), then start the MCP server:

poetry run python -m src.client.server

⚠️ Important Note

Make sure ZERION_API_KEY is set if you plan to use any Zerion analytics tools.

Advanced Usage

Verifying Your Setup

Run the verification script to ensure everything is configured correctly:

python scripts/verify_setup.py

This script will:

• Test all module imports.
• Verify environment configuration.
• Check API connectivity.
• Validate helper functions.
• Provide a comprehensive setup report.

📚 Documentation

Available Tools

API Tools (src/client/tools/api/)

Zerion Tools (src/client/tools/zerion/)

⚠️ Important Note

These tools require the ZERION_API_KEY environment variable to be set.

Project Structure

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

Configuration

Environment Variables

The client requires the following environment variables:

# Required: Zerion API Key for portfolio analytics
export ZERION_API_KEY="your_zerion_api_key_here"

Getting API Keys

Zerion API Key

To use Zerion analytics tools, you'll need a Zerion API key:

1. Visit Zerion Developer Portal.
2. Sign up for a developer account.
3. Create a new API key.
4. Set the ZERION_API_KEY environment variable.

Setting Environment Variables

Create a .env file in the project root:

# .env file
ZERION_API_KEY=your_zerion_api_key_here

Or set them directly in your shell:

export ZERION_API_KEY="your_zerion_api_key_here"

API Endpoints

The following API endpoints are used (hardcoded in the application):

• Odos API: https://api.odos.xyz (no authentication required).
• Zerion API: https://api.zerion.io (requires API key).

Development

Setup Development Environment

# Install development dependencies
pip install -r requirements-dev.txt

# Run formatting
python scripts/format.py

# Run tests

Adding New Tools

1. Create a tool file in the appropriate directory (api/ or zerion/).
2. Add a brief description docstring.
3. Implement using the FastMCP decorator pattern.
4. Update __init__.py exports.
5. Add tests in the tests/ directory.

Contributing

1. Fork the repository.
2. Create a feature branch (git checkout -b feature/amazing-feature).
3. Commit changes (git commit -m 'Add amazing feature').
4. Push to the branch (git push origin feature/amazing-feature).
5. Open a Pull Request.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

Support

For questions or issues:

• Create an issue in the repository.
• Check existing documentation and tool descriptions.
• Review the Odos API documentation for parameter details.