Skip to main content

MCP server for Aerodrome Swap API

Project description

Aerodrome Swap MCP Server

This is a Model Context Protocol (MCP) server that provides integration with the Aerodrome Swap API. It allows users to interact with Aerodrome's decentralized exchange functionality through the MCP framework.

Features

  • Interact with Aerodrome Swap API
  • Support for token swaps
  • Pool information retrieval
  • Price information retrieval
  • Quote generation

Prerequisites

  • Python 3.8+
  • Conda environment activated

Installation

# Clone the repository
git clone <repository-url>
cd aerodrome-swap-mcp

# Install dependencies
pip install -r requirements.txt

Usage

# Start the MCP server
npx aerodrome-swap-mcp

Or alternatively, you can install and run it locally:

# Install the package
pip install -e .

# Start the MCP server
aerodrome-swap-mcp

API Reference

This MCP server provides the following tools for interacting with the Aerodrome Swap API:

Token Operations

  • get_tokens - Get all tokens with optional filtering

    • target (str, optional): The target blockchain, "base", "aero", "optimistic-ethereum", "velo". Defaults to "aero".
    • limit (int, optional): Max tokens to return (1-1000, default: 100). Defaults to 100.
    • offset (int, optional): Skip tokens for pagination (default: 0). Defaults to 0.
    • listed_only (bool, optional): Only return listed tokens. Defaults to False.
  • get_token_by_address - Get detailed information about a specific token.

    • address (str): The token address.
    • target (str, optional): The target blockchain, "base", "aero", "optimistic-ethereum", "velo". Defaults to "aero".
  • get_tokens_batch - Get information for multiple tokens in a single request. Useful for efficiently fetching data for token lists.

    • addresses (List[str]): The list of token addresses to retrieve information for.
    • target (str, optional): The target blockchain, "base", "aero", "optimistic-ethereum", "velo". Defaults to "aero".
  • search_tokens - Search for tokens by symbol or address. This is useful for token selection in UI components.

    • query (str): Search term (symbol or address).
    • target (str, optional): The target blockchain, "base", "aero", "optimistic-ethereum", "velo". Defaults to "aero".
    • limit (int, optional): Max results (1-50, default: 10)

Price Operations

  • get_prices - Get current token prices. This endpoint is optimized for high-frequency price queries with intelligent caching.

    • target (str, optional): The target blockchain, "base", "aero", "optimistic-ethereum", "velo". Defaults to "aero".
    • limit (int, optional): limit (int, optional): Max pools to return (1-1000, default: 100). Only worked when "symbols" is empty. Defaults to 50.
    • offset (int, optional): Skip pools for pagination (default: 0). Only worked when "symbols" is empty. Defaults to 0.
    • symbols (Optional[List[str]], optional): The token symbols to filter prices by. When "symbols" is set, "limit" and "offset" are ignored. Exp, "AERO,USDC". Defaults to None.
  • get_price_by_address - Get price for a specific token.

    • address (str): The token address.
    • target (str, optional): The target blockchain, "base", "aero", "optimistic-ethereum", "velo". Defaults to "aero".

Pool Operations

  • get_pools - Get a list of Aerodrome pools

    • target (str, optional): The target blockchain, "base", "aero", "optimistic-ethereum", "velo". Defaults to "aero".
    • limit (int, optional): Max pools to return (1-1000, default: 100). Defaults to 100.
    • offset (int, optional): Skip pools for pagination (default: 0). Defaults to 0.
    • token (Optional[str], optional): The token address to filter pools by. Defaults to None.
  • get_pools_detailed - Get detailed pool information with TVL, APR, volume, fees, and voting rewards

    • target (str, optional): The target blockchain, "base", "aero", "optimistic-ethereum", "velo". Defaults to "aero".
    • limit (int, optional): Max pools to return (1-1000, default: 100). Defaults to 100.
    • offset (int, optional): Skip pools for pagination (default: 0). Defaults to 0.
    • sort_by (str, optional): The field to sort by, must be one of: tvl, apr, volume, fees. Defaults to "tvl".
    • symbol (Optional[str], optional): The pool symbol. Defaults to None.
    • min_tvl (Optional[int], optional): The minimum TVL to filter pools by. Defaults to None.
  • get_pool_by_address - Get detailed information about a specific pool by address.

    • address (str): The address of the pool.
    • token0 (Optional[str], optional): The token0 address to filter pools by. Defaults to None.
    • target (str, optional): The target blockchain, "base", "aero", "optimistic-ethereum", "velo". Defaults to "aero".
  • search_pools - Search for pools by token pair and other criteria. At least one token address is required.

    • token0 (Optional[str], optional): The token0 address to filter pools by. Defaults to None.
    • token1 (Optional[str], optional): The token1 address to filter pools by. Defaults to None.
    • target (str, optional): The target blockchain, "base", "aero", "optimistic-ethereum", "velo". Defaults to "aero".

Swap Operations

  • get_quote - Get quotes for Aerodrome

    • from_token (str): Token to swap from (contract address)
    • to_token (str): Token to swap to (contract address)
    • amount (int): Amount to swap (in token units, not wei)
    • target (str, optional): The target blockchain, "base", "aero", "optimistic-ethereum", "velo". Defaults to "aero".
  • build_swap - Simulates transaction (customer needs to approve on their end)

    • from_token (str): Token to swap from (contract address)
    • to_token (str): Token to swap to (contract address)
    • amount (str): Amount to swap (in token units, not wei)
    • wallet_address (str): Wallet address to execute swap.
    • target (str, optional): The target blockchain, "base", "aero", "optimistic-ethereum", "velo". Defaults to "aero".
    • slippage (float, optional): Slippage tolerance (0.001-0.5, default: 0.005)
  • get_transaction - Get transaction after swap.

    • tx_hash (str): Transaction hash.
    • target (str, optional): The target blockchain. Defaults to "aero".

Development

To contribute to this project:

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Submit a pull request

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aerodrome_swap_mcp-0.1.0.tar.gz (11.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

aerodrome_swap_mcp-0.1.0-py3-none-any.whl (9.0 kB view details)

Uploaded Python 3

File details

Details for the file aerodrome_swap_mcp-0.1.0.tar.gz.

File metadata

  • Download URL: aerodrome_swap_mcp-0.1.0.tar.gz
  • Upload date:
  • Size: 11.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.0

File hashes

Hashes for aerodrome_swap_mcp-0.1.0.tar.gz
Algorithm Hash digest
SHA256 dc26bd29cc9ce7f86b809041ad0c1139fed8e6193737f04ae79e89d55f6e65b7
MD5 739ce7bffd44535f8684f0a35f365fad
BLAKE2b-256 97aa5b310e7866e50108a6dc5b828574f467ef4cb5a4f7639f1285d1ac59c1a9

See more details on using hashes here.

File details

Details for the file aerodrome_swap_mcp-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for aerodrome_swap_mcp-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 49e489aaf131959d425097f2b302be1e7f517ae4dfd9028bb9bffddb99b0ae8a
MD5 8e1fbaf27f4cdb8a312ca64ae4b90e55
BLAKE2b-256 bc0586f76b48e5636b94ae5febc9dfaf4fceabe3552c3556f1354e03234d1793

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page