Hyperliquid WhaleAlert

An MCP server that provides real-time whale alerts on Hyperliquid.

python

12

GitHub Stars

python

Language

6 months ago

First Indexed

2 months ago

Catalog Refreshed

Documentation & install

Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.

Installation

Add the following to your MCP client configuration file.

Configuration

View docs

{
  "mcpServers": {
    "kukapay-hyperliquid-whalealert-mcp": {
      "command": "uv",
      "args": [
        "--directory",
        "/path/to/hyperliquid-whalealert-mcp",
        "run",
        "main.py"
      ],
      "env": {
        "COINGLASS_API_KEY": "YOUR_API_KEY"
      }
    }
  }
}

You set up the Hyperliquid WhaleAlert MCP server to receive real-time whale transaction alerts and generate concise summaries. This makes it easy to fetch notable whale activity and track key metrics from Hyperliquid data feeds directly through an MCP client.

How to use

Use the MCP client to run the available tools and prompts. The main tools are get_whale_alerts, which fetches recent whale transactions and formats them as a Markdown table, and the summarize_whale_activity prompt, which analyzes whale activity to produce a concise summary with metrics like total position value and notable symbols.

How to install

Prerequisites: Python 3.10 or higher, CoinGlass API key, and uv (the MCP package and dependency manager). Ensure your environment has these ready before proceeding.

Step 1 – Clone the repository and navigate into it.

git clone https://github.com/kukapay/hyperliquid-whalealert-mcp.git
cd hyperliquid-whalealert-mcp

Step 2 – Install dependencies via uv sync.

uv sync

Step 3 – Install and run the MCP server from Claude Desktop using the provided command.

uv run mcp install mcp.py --name "Hyperliquid Whale Alert"

If you prefer to configure the MCP server manually, add the following configuration and replace the path and API key with your values.

{
  "mcpServers": {
    "hyperliquid_whalealert": {
      "command": "uv",
      "args": [ "--directory", "/path/to/hyperliquid-whalealert-mcp", "run", "main.py" ],
      "env": { "COINGLASS_API_KEY": "your_api_key" }
    }
  }
}

Additional setup notes

Replace /path/to/hyperliquid-whalealert-mcp with your actual installation path and set COINGLASS_API_KEY to your CoinGlass API key. After saving, start or reload the MCP server so the new configuration takes effect.

Configuration, security, and usage tips

Keep your CoinGlass API key secure and do not share it publicly. - If you rotate your API key, update the MCP server environment variable accordingly and reload the server.
The server exposes two main capabilities: fetching whale alerts via get_whale_alerts and summarizing activity via the summarize_whale_activity prompt. Use them through your MCP client UI or API as needed.

Examples

To fetch whale alerts, invoke the get_whale_alerts tool in your MCP client. The output is formatted as a Markdown list for easy viewing.

To get a summary of whale activity, trigger the summarize_whale_activity prompt in a compatible client. This will provide metrics like total position value and notable symbols.

Available tools

get_whale_alerts

Fetches recent whale transactions and formats them as a Markdown table using pandas for clean formatting.

summarize_whale_activity

Generates a summary of whale transactions, including metrics like total position value and notable symbols.