Skip to content

Latest commit

 

History

History
116 lines (78 loc) · 4.19 KB

README.md

File metadata and controls

116 lines (78 loc) · 4.19 KB

Coin MCP Server

smithery badge

A Model Context Protocol server that provides access to CoinMarketCap's cryptocurrency data. This server enables AI-powered applications to retrieve cryptocurrency listings, quotes, and detailed information about various coins.

Available Tools

  • listing-coins - Fetches a paginated list of all active cryptocurrencies with the latest market data.

    • start (integer, optional): Offset the start (1-based index) of the paginated list of items to return.
    • limit (integer, optional): Number of results to return (default: 10, max: 5000).
    • price_min (number, optional): Minimum USD price to filter results.
    • price_max (number, optional): Maximum USD price to filter results.
    • market_cap_min (number, optional): Minimum market cap to filter results.
    • market_cap_max (number, optional): Maximum market cap to filter results.
    • convert (string, optional): Calculate market quotes in multiple currencies.
    • sort (string, optional): Field to sort the list of cryptocurrencies by.
    • sort_dir (string, optional): Direction to order cryptocurrencies (asc or desc).

  • get-coin-info - Retrieves detailed information about a specific cryptocurrency.

    • id (string, optional): One or more comma-separated CoinMarketCap cryptocurrency IDs.
    • slug (string, optional): A comma-separated list of cryptocurrency slugs.
    • symbol (string, optional): One or more comma-separated cryptocurrency symbols.

  • get-coin-quotes - Fetches the latest market quotes for one or more cryptocurrencies.

    • id (string, optional): One or more comma-separated cryptocurrency CoinMarketCap IDs.
    • slug (string, optional): A comma-separated list of cryptocurrency slugs.
    • symbol (string, optional): One or more comma-separated cryptocurrency symbols.

Installation

Installing via Smithery

To install Cryptocurrency Data for Claude Desktop automatically via Smithery:

npx -y @smithery/cli install coin-api-mcp --client claude

Build the Server

Clone this repository and build and install the program with your default Python interpreter (recommended).

git clone https://github.com/longmans/coin_api_mcp.git
cd coin_api_mcp
uv build
uv pip install .

After installation, you can run it as a script using:

python -m coin_api_mcp

Configuration

API Key

The server requires a CoinMarketCap API key to function. You can obtain one from CoinMarketCap's website. The API key can be provided in two ways:

  1. As an environment variable:
export COINMARKETCAP_API_KEY=your_api_key_here
  1. As a command-line argument:
python -m coin_api_mcp --api-key=your_api_key_here

Configure for Claude.app

Add to your Claude settings:

Using pip installation 
"mcpServers": {
  "coin_api": {
    "command": "python",
    "args": ["-m", "coin_api_mcp"]
  },
  "env": {
        "COINMARKETCAP_API_KEY": "your_api_key_here"
  }
}

If you see any issue, you may want to use the full path for the Python interpreter you are using. You can do a which python to find out the exact path if needed.

Remember to set the COINMARKETCAP_API_KEY environment variable or provide it via the --api-key argument.

Debugging

You can use the MCP inspector to debug the server

Contributing

We encourage contributions to help expand and improve Coin MCP Server. Whether you want to add new search capabilities, enhance existing functionality, or improve documentation, your input is valuable.

For examples of other MCP servers and implementation patterns, see: https://github.com/modelcontextprotocol/servers

Pull requests are welcome! Feel free to contribute new ideas, bug fixes, or enhancements to make Coin MCP Server even more powerful and useful.

License

Coin MCP Server is licensed under the MIT License. This means you are free to use, modify, and distribute the software, subject to the terms and conditions of the MIT License. For more details, please see the LICENSE file in the project repository.