Upbit MCP server for AI agents

The Upbit MCP server provides a fast interface for interacting with the Upbit cryptocurrency exchange, offering both public market data tools and optional private trading functionality. This server implements the Model Context Protocol (MCP) to enable seamless communication with various clients.

Requirements

Node.js 18 or higher
pnpm 8 or higher

Installation

Install the required dependencies:

pnpm install

Environment Configuration

Copy the example environment file and edit it with your credentials:

cp .env.example .env

The environment file should contain:

UPBIT_SERVER_URL=https://api.upbit.com
UPBIT_ACCESS_KEY=
UPBIT_SECRET_KEY=
UPBIT_ENABLE_TRADING=false

Obtaining Upbit API Keys

To use private trading features, you'll need Upbit API keys:

Create an account on Upbit if you don't have one
Visit the Upbit Developer Center
Create a new API key
Set appropriate permissions (read, trade, withdraw as needed)
Add your API keys to the .env file and set UPBIT_ENABLE_TRADING=true to enable private tools

Security Considerations

Keep your UPBIT_SECRET_KEY private and set IP allowlisting in Upbit
Only set UPBIT_ENABLE_TRADING=true when you need to place/cancel orders or manage deposits/withdrawals
Upbit permissions map to specific Korean terms:
- Orders: create/cancel → 주문하기, query/list → 주문조회
- Accounts/balances → 자산조회
- Withdrawals: create/cancel → 출금하기, query/list/address → 출금조회
- Deposits: create address → 입금하기, query/list/chance/address → 입금조회

Building and Running

Build and start the server:

pnpm run build
pnpm run start

For easier testing (in project root):

pnpm run build
npx @modelcontextprotocol/inspector node dist/index.js

If installed globally or via npx, you can run:

mcp-upbit-server

The server runs over stdio for MCP clients.

Available Tools

Public Tools

These tools are available without authentication:

GET_TICKER — Get the latest ticker for a market
- Parameters: { "market": "KRW-BTC" }
GET_ORDERBOOK — Get orderbook snapshot
- Parameters: { "market": "KRW-BTC" }
GET_TRADES — Get recent trades
- Parameters: { "market": "KRW-BTC" }

Private Tools

These tools require API keys and UPBIT_ENABLE_TRADING=true:

GET_ACCOUNTS — Get account balances
GET_ORDERS — List orders
- Optional parameters: { market?, state?, page?, limit? }
GET_ORDER — Get order details
- Parameters: { uuid? , identifier? }
CREATE_ORDER — Place a new order
- Parameters: { market, side, ord_type, volume?, price? }
CANCEL_ORDER — Cancel an existing order
- Parameters: { uuid }
LIST_WITHDRAWAL_ADDRESSES — List withdrawal addresses
CREATE_WITHDRAWAL — Create a withdrawal
- Parameters: { currency, amount, address, net_type, secondary_address?, transaction_type? }
GET_WITHDRAWAL — Get withdrawal details
- Parameters: { uuid }
LIST_WITHDRAWALS — List withdrawals
- Optional parameters: { currency?, state?, page?, limit? }
CANCEL_WITHDRAWAL — Cancel a withdrawal
- Parameters: { uuid }
GET_DEPOSIT_CHANCE — Get deposit availability information
- Parameters: { currency, net_type? }
CREATE_DEPOSIT_ADDRESS — Create a deposit address
- Parameters: { currency, net_type }
GET_DEPOSIT_ADDRESS — Get a deposit address
- Parameters: { currency, net_type }
LIST_DEPOSIT_ADDRESSES — List deposit addresses
GET_DEPOSIT — Get deposit details
- Parameters: { uuid }
LIST_DEPOSITS — List deposits
- Optional parameters: { currency?, state?, page?, limit? }

Usage Examples

Market Buy Order (10,000 KRW)

{
  "name": "CREATE_ORDER",
  "arguments": {
    "market": "KRW-BTC",
    "side": "bid",
    "ord_type": "price",
    "price": "10000"
  }
}

Limit Sell Order with Post-Only Flag

{
  "name": "CREATE_ORDER",
  "arguments": {
    "market": "KRW-BTC",
    "side": "ask",
    "ord_type": "limit",
    "volume": "0.01",
    "price": "100000000",
    "time_in_force": "post_only",
    "identifier": "my-unique-id-001"
  }
}

List Withdrawals (Paginated)

{
  "name": "LIST_WITHDRAWALS",
  "arguments": { "page": 1, "limit": 50 }
}

Check Deposit Availability for Bitcoin

{
  "name": "GET_DEPOSIT_CHANCE",
  "arguments": { "currency": "BTC" }
}

All tool outputs are returned as JSON strings for easy display and processing.

How to install this MCP server

For Claude Code

To add this MCP server to Claude Code, run this command in your terminal:

claude mcp add-json "upbit" '{"command":"mcp-upbit-server","args":[]}'

See the official Claude Code MCP documentation for more details.

For Cursor

There are two ways to add an MCP server to Cursor. The most common way is to add the server globally in the ~/.cursor/mcp.json file so that it is available in all of your projects.

If you only need the server in a single project, you can add it to the project instead by creating or adding it to the .cursor/mcp.json file.

Adding an MCP server to Cursor globally

To add a global MCP server go to Cursor Settings > Tools & Integrations and click "New MCP Server".

When you click that button the ~/.cursor/mcp.json file will be opened and you can add your server like this:

{
    "mcpServers": {
        "upbit": {
            "command": "mcp-upbit-server",
            "args": []
        }
    }
}

Adding an MCP server to a project

To add an MCP server to a project you can create a new .cursor/mcp.json file or add it to the existing one. This will look exactly the same as the global MCP server example above.

How to use the MCP server

Once the server is installed, you might need to head back to Settings > MCP and click the refresh button.

The Cursor agent will then be able to see the available tools the added MCP server has available and will call them when it needs to.

You can also explicitly ask the agent to use the tool by mentioning the tool name and describing what the function does.

For Claude Desktop

To add this MCP server to Claude Desktop:

1. Find your configuration file:

macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
Windows: %APPDATA%\Claude\claude_desktop_config.json
Linux: ~/.config/Claude/claude_desktop_config.json

2. Add this to your configuration file:

{
    "mcpServers": {
        "upbit": {
            "command": "mcp-upbit-server",
            "args": []
        }
    }
}

3. Restart Claude Desktop for the changes to take effect