Skip to main content

MCP server for trade.xyz — analysis and trading of the xyz HIP-3 markets (xyz:AAPL, xyz:GOLD, ...) on Hyperliquid, with in-code guardrails. Fork of hyperliquid-mcp.

Project description

mcpxyz — MCP server for trade.xyz (HIP-3 on Hyperliquid)

PyPI Python License: MIT MCP

An MCP server that lets an AI assistant (Claude Desktop, Claude Code, …) analyse and trade the xyz markets — tokenized equities, commodities and indices like xyz:AAPL, xyz:GOLD, xyz:NVDA, xyz:XYZ100 — exposed by trade.xyz.

trade.xyz has no proprietary API: it is a UI over the xyz HIP-3 perp dex deployed on Hyperliquid. Everything here goes through the standard Hyperliquid API, with markets namespaced xyz:.

⚠️ Not financial advice. Trading involves risk of loss. Use at your own risk.

Safety model

This server signs financial transactions, so guardrails are enforced in code (not via the prompt):

  • Read-only by default — no order is signed unless READ_ONLY=false and a key is set.
  • Delegated API wallet only — use a Hyperliquid API wallet (no withdrawal rights). The withdraw tool has been removed entirely.
  • Asset whitelist — writes are limited to ALLOWED_ASSETS (empty ⇒ all writes blocked).
  • Per-order capsMAX_ORDER_SIZE, MAX_ORDER_NOTIONAL_USD, MAX_LEVERAGE.
  • Two-step ordersplace_order returns a preview + token; nothing is signed until you call confirm_order.
  • Kill switchcancel_all_orders is always available and never whitelisted.

See SECURITY.md for the full policy and key-handling guidance.

Tools

Market data (read-only): get_markets_overview (all markets in one call — price, 24h change, funding, OI, volume; sortable for top movers), get_market_data, get_candle_data, get_l2_orderbook, get_funding_rates, calculate_min_order_size.

Account: get_positions (xyz isolated margin account), get_spot_user_state, get_user_fees, update_leverage, transfer (move collateral between core / spot / xyz).

Orders: place_order (preview) → confirm_order, cancel_order, cancel_all_orders, bulk_cancel_orders, modify_order, get_open_orders, get_order_status, get_user_fills, get_user_fills_by_time.

Assets are accepted namespaced (xyz:AAPL) or bare (AAPL, apple) — they are normalized automatically.

Requirements

Python 3.11+ and one launcher: uv (recommended), pip, or pipx.

Works with any MCP client

mcp-xyz speaks standard MCP (stdio / HTTP / SSE), so it works with any MCP-compatible client — regardless of the underlying LLM: Claude Desktop, Claude Code, Cursor, Cline, Continue, Windsurf, Zed, or your own agent via the Python / TypeScript MCP SDKs. The examples below use Claude Desktop's config format; other clients use the same command + args (+ env) in their own config file.

Get a delegated API wallet (trading only)

  1. In the Hyperliquid / trade.xyz UI, create an API wallet (a.k.a. agent wallet). It can trade but cannot withdraw funds.
  2. Copy its private key → this is your HYPERLIQUID_PRIVATE_KEY. Never use your main account key.

Install — three ways

1. Clone the repo (best for builders)

Get the code, keep your config in a gitignored .env, and let your IDE agent wire it in.

git clone https://github.com/akugone/mcp-xyz
cd mcp-xyz
cp .env.example .env    # analysis: leave as-is · trading: add your API wallet key

Then either ask your IDE agent (Claude Code, Cursor, …) to "add this repo as an MCP server" — it reads this README and wires it up — or add it manually:

{ "mcpServers": { "xyz": {
  "command": "uv",
  "args": ["--directory", "/absolute/path/to/mcp-xyz", "run", "mcpxyz"]
} } }

The .env in the folder is loaded automatically, so all config lives there (no env block needed). For Claude Code, one command does it:

claude mcp add xyz -- uv --directory /absolute/path/to/mcp-xyz run mcpxyz

2. From PyPI (recommended for users)

No clone. Generate a ready-to-paste config with init:

uvx mcpxyz init            # analysis (read-only)
uvx mcpxyz init --trading  # with a trading env block to fill in

Paste the snippet into your client's config, fill your key if trading, restart the client. No uv? pip install mcpxyz (then use mcpxyz as the command) or pipx run mcpxyz — same result.

3. Claude Desktop (copy-paste)

Config file: ~/Library/Application Support/Claude/claude_desktop_config.json (macOS) · %APPDATA%\Claude\claude_desktop_config.json (Windows). Merge the xyz entry and fully restart Claude Desktop.

Analysis only — zero config, no key:

{
  "mcpServers": {
    "xyz": { "command": "uvx", "args": ["mcpxyz"] }
  }
}

Reads (prices, funding, candles, orderbook) work immediately. No key ⇒ fully read-only, no order can be placed.

Trading — add your own delegated API wallet key:

{
  "mcpServers": {
    "xyz": {
      "command": "uvx",
      "args": ["mcpxyz"],
      "env": {
        "HYPERLIQUID_PRIVATE_KEY": "0x<your_delegated_api_wallet_key>",
        "HYPERLIQUID_USER_ADDRESS": "0x<your_main_account_address>",
        "READ_ONLY": "false",
        "ALLOWED_ASSETS": "xyz:*",
        "MAX_ORDER_NOTIONAL_USD": "100"
      }
    }
  }
}

ALLOWED_ASSETS: "xyz:*" allows trading every xyz market. To restrict trading to specific markets, list them instead, e.g. "xyz:AAPL,xyz:GOLD".

Your key stays on your machine — it is only read from this env block (or, for local development, a gitignored .env) and never sent anywhere.

Environment variables

Variable Default Description
HYPERLIQUID_PRIVATE_KEY Delegated API wallet key. Empty ⇒ read-only.
HYPERLIQUID_USER_ADDRESS wallet addr Address to query positions/fills for.
HYPERLIQUID_TESTNET false Use testnet instead of mainnet.
READ_ONLY true Must be false (and a key set) to sign anything.
XYZ_DEX xyz HIP-3 perp dex namespace.
ALLOWED_ASSETS Comma-separated whitelist for writes (e.g. xyz:AAPL,xyz:GOLD). xyz:* allows all xyz markets. Empty ⇒ writes blocked. Reads are never restricted.
MAX_ORDER_SIZE Max size per order.
MAX_ORDER_NOTIONAL_USD Max notional (USD) per order.
MAX_LEVERAGE Max leverage for update_leverage.
HYPERLIQUID_MCP_SHOW_LOGS false Keep false in production.

Usage flow

  1. Explore read-only: get_market_data xyz:AAPL → candles → L2 → funding.
  2. Check get_positions.
  3. place_order (limit, away from the price) → review the preview → confirm_order.
  4. cancel_order / cancel_all_orders.

Validation & tests

  • uv run pytest — offline unit tests (guardrails, models, tool registration, order flow).
  • Write-path validation on testnet: see docs/VALIDATION.md and scripts/validate_testnet.py.

Transports

mcpxyz                       # stdio (default)
mcpxyz --transport http --port 3000
mcpxyz --transport sse  --port 3000

Credits & license

Fork of midodimori/hyperliquid-mcp (MIT). Adapted for the trade.xyz HIP-3 markets with in-code guardrails. Licensed under MIT.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mcpxyz-0.2.2.tar.gz (212.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mcpxyz-0.2.2-py3-none-any.whl (35.8 kB view details)

Uploaded Python 3

File details

Details for the file mcpxyz-0.2.2.tar.gz.

File metadata

  • Download URL: mcpxyz-0.2.2.tar.gz
  • Upload date:
  • Size: 212.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.7 {"installer":{"name":"uv","version":"0.11.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for mcpxyz-0.2.2.tar.gz
Algorithm Hash digest
SHA256 b1b2a448b2066334c4876a594c01f65b338e175397d883f1d05a31f958fc401b
MD5 f83b32eaf4ddcf0b3972943de8bcca04
BLAKE2b-256 141210d181ab4e6e3e92dffdcef16c3ec906f3283a6a0078b793283a1da87a19

See more details on using hashes here.

File details

Details for the file mcpxyz-0.2.2-py3-none-any.whl.

File metadata

  • Download URL: mcpxyz-0.2.2-py3-none-any.whl
  • Upload date:
  • Size: 35.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.7 {"installer":{"name":"uv","version":"0.11.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for mcpxyz-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 9e4c97b6cdb276d7f873d4ac33101d35048a88c73ac37d414be8d33f523141fb
MD5 92af154ef538d035b9c6020a4a12affa
BLAKE2b-256 5072b7912f7a3c470dac539303e827a92138f305560a5c67c2f1025730caf0b4

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page