Coingecko MCP Server

🚀 CoinGecko Server

A Model Context Protocol (MCP) server and OpenAI function call service for interacting with the CoinGecko Pro API.

🚀 Quick Start

The CoinGecko Server is a powerful tool that enables interaction with the CoinGecko Pro API. It provides various functions to access cryptocurrency data, including listing supported coins, retrieving historical data, and more.

✨ Features

• List supported cryptocurrencies with pagination.
• Find Coin IDs by name or symbol.
• Retrieve historical price, market cap, and volume data.
• Get OHLC (Open, High, Low, Close) candlestick data.
• Maintain a local coin cache with a refresh function.

📦 Installation

npm install coingecko-server

🛠️ Environment Configuration

Create a .env file in the project root directory:

COINGECKO_API_KEY=your_api_key_here

💻 Usage with Claude Desktop

Claude Desktop fully supports MCP functionality. To use this server:

1. Install Claude Desktop.

2. Add the following to your Claude Desktop configuration:

   • On macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
   • On Windows: %APPDATA%\Claude\claude_desktop_config.json

{
  "mcpServers": {
    "coingecko": {
      "command": "node",
      "args": ["/path/to/coingecko-server/build/index.js"],
      "env": {
        "COINGECKO_API_KEY": "your-api-key-here"
      }
    }
  }
}

3. Restart Claude Desktop.

This server provides the following tools:

• get-coins: Get a paginated list of supported coins.
• find-coin-ids: Find CoinGecko IDs for cryptocurrency names or symbols.
• get-historical-data: Get historical price, market cap, and volume data.
• get-ohlc-data: Get OHLC candlestick data.
• refresh-cache: Refresh the local coin list cache.

💻 Usage with OpenAI Function Call

import { CoinGeckoService } from 'coingecko-server';
import OpenAI from 'openai';

const openai = new OpenAI();
const coinGeckoService = new CoinGeckoService(process.env.COINGECKO_API_KEY);

// Get function definitions
const functions = CoinGeckoService.getOpenAIFunctionDefinitions();

// Example: Get historical data
const response = await openai.chat.completions.create({
  model: "gpt-4-turbo-preview",
  messages: [{ role: "user", content: "Get the historical price of Bitcoin for the past week" }],
  functions: [functions[2]], // get_historical_data function
  function_call: "auto",
});

if (response.choices[0].message.function_call) {
  const args = JSON.parse(response.choices[0].message.function_call.arguments);
  const history = await coinGeckoService.getHistoricalData(
    args.id,
    args.vs_currency,
    args.from,
    args.to,
    args.interval
  );
}

📚 Data Types

Basic Usage

// OHLCData interface
interface OHLCData {
  open: number;
  high: number;
  low: number;
  close: number;
  volume?: number;
  timestamp: string;
}

// HistoricalData interface
interface HistoricalData {
  [key: string]: OHLCData[];
}

// CoinInfo interface
interface CoinInfo {
  id: string;
  symbol: string;
  name: string;
  priceUsd: string;
  marketCapUsd: string;
  volumeUsd24Hr: string;
  latestUpdate: string;
}

⚠️ Rate Limiting

For API call rate limits, please refer to the CoinGecko Pro API documentation.

📄 License

This library is released under the MIT License.