0.1.1 • Published 3 months ago

@solangii/upbit-mcp-server v0.1.1

Weekly downloads
-
License
MIT
Repository
github
Last release
3 months ago

Upbit MCP Server

A server implementation for Upbit Cryptocurrency Exchange OpenAPI using the Model Context Protocol (MCP). This project provides tools to interact with Upbit exchange services, such as retrieving market data (quotes, orderbooks, trade history, chart data), account information, creating and canceling orders, managing deposits/withdrawals, and performing technical analysis.

Features

  • Market data retrieval (ticker, orderbook, trades, candle data)
  • Account information (balance, order history)
  • Order creation and cancellation
  • Deposit and withdrawal functions
  • Technical analysis tools

Prerequisites

Before you begin, you need to get your Upbit API keys:

  1. Create an account on Upbit if you don't already have one
  2. Go to the Upbit Developer Center
  3. Create a new API key
  4. Make sure to set appropriate permissions (read, trade, withdraw as needed)
  5. Store your API keys(UPBIT_ACCESS_KEY, UPBIT_SECRET_KEY) in the .env file (see Installation section)

Installation

Option 1: Using NPX (Recommended)

The easiest way to run this server is using npx:

npx -y @solangii/upbit-mcp-server

This will automatically install and run the MCP server.

Option 2: Global Installation

You can also install the package globally:

npm install -g @solangii/upbit-mcp-server

Then run it using:

upbit-mcp-server

Option 3: Manual Installation (Source Code)

  1. Clone the repository:

    git clone https://github.com/solangii/upbit-mcp.git
    cd upbit-mcp
  2. Install dependencies:

    # Using pip
    pip install -e .
    
    # Or using uv (recommended)
    uv pip install -e .

    Using uv provides faster installation and more reliable dependency resolution. To install uv:

    # Install uv
    curl -Ls https://astral.sh/uv/install.sh | sh
    
    # Or install with pip
    pip install uv
  3. Set up environment variables: Create a .env file in the project root and add your Upbit API keys:

    UPBIT_ACCESS_KEY=your_access_key_here
    UPBIT_SECRET_KEY=your_secret_key_here

API Keys Configuration

For any installation method, you'll need to set up your Upbit API keys. Create a .env file in the directory where you run the server with the following content:

UPBIT_ACCESS_KEY=your_access_key_here
UPBIT_SECRET_KEY=your_secret_key_here

Usage

Development Mode (Web Interface)

fastmcp dev main.py

Install in Claude Desktop

Option 1: Using fastmcp

fastmcp install main.py --name "Upbit API"

Option 2: Using Claude config file (Direct integration)

You can add the MCP server directly to Claude's configuration file:

  1. Install Claude Desktop

  2. Add the following to your Claude Desktop configuration:

    • macOS: ~/Library/Application Support/Claude/claude_desktop_config.json`
    • Windows: %APPDATA%\Claude\claude_desktop_config.json
  3. Add the following configuration (adjust paths as needed):

    {
      "mcpServers": {
        "upbit-mcp-server": {
          "command": "python",
          "args": [
            "/full/path/to/upbit-mcp-server/main.py"
          ],
          "env": {
            "UPBIT_ACCESS_KEY": "your_access_key_here",
            "UPBIT_SECRET_KEY": "your_secret_key_here"
          }
        }
      }
    }
  4. Restart Claude to load the new configuration.

Deploy with Smithery.ai

  1. Ensure your repository has both the Dockerfile and smithery.yaml files.
  2. Visit Smithery.ai and follow the instructions to deploy your MCP server.
  3. Once deployed, you can add the server to Claude using the provided URL.

Run Directly with Python

python main.py

# Or using uv
uv run python main.py

Caution

  • This server can process real trades, so use it carefully.
  • Keep your API keys secure and never commit them to public repositories.
  • Thoroughly test before using in production environments.

License

MIT

0.1.1

3 months ago

0.1.0

3 months ago