Skip to content

README.md

Latest commit

 

History

History
71 lines (56 loc) · 1.84 KB

README.md

File metadata and controls

71 lines (56 loc) · 1.84 KB

Sugar MCP Server

This is an MCP (Model Context Protocol) server to interact with Sugar
Sugar makes Velodrome and Aerodrome devs life sweeter 🍭

Components

Environment Variables

  • SUGAR_PK: The public key for the SUGAR service.
  • SUGAR_RPC_URI_10: The RPC URI for the SUGAR service.

Tools

  • get_all_tokens: Retrieve all tokens supported by the protocol.
  • get_prices: Retrieve prices for a list of tokens in terms of the stable token.
  • get_pools: Retrieve all liquidity pools or swap pools depending on the flag.
  • get_pool_by_address: Retrieve detailed pool information by contract address.
  • get_pools_for_swaps: Retrieve all pools suitable for swaps and path finding.
  • get_latest_pool_epochs: Retrieve the latest epoch data for all pools.
  • get_pool_epochs: Retrieve historical epoch data for a given liquidity pool.
  • get_quote: Retrieve the best quote for swapping a given amount from one token to another.
  • swap: Execute a token swap transaction.
  • get_pools_by_token: Retrieve liquidity pools that contain a specific token.
  • get_pools_by_pair: Retrieve liquidity pools that contain a specific token pair.
  • get_pool_list: Retrieve liquidity pools based on specified criteria.

Usage

{
  "mcpServers": {
    "sugar-mcp": {
      "env": {
        "SUGAR_PK": "xxx",
        "SUGAR_RPC_URI_10": "optionally, the RPC URI for the SUGAR service"
      },
      "command": "uvx",
      "args": [
        "sugar-mcp"
      ]
    }
  }
}

Building and Publishing to PyPI

To build and publish this package to PyPI:

  1. Install build dependencies:
pip install build twine
  1. Build the package:
python -m build
  1. Upload to PyPI:
twine upload dist/*

Or if using Poetry (as specified in pyproject.toml):

poetry build
poetry publish