Skip to content

Latest commit

 

History

History
80 lines (59 loc) · 6.75 KB

File metadata and controls

80 lines (59 loc) · 6.75 KB
title Features Table
description Complete reference of Perps MCP capabilities with example prompts and commands

Complete reference of Perps MCP capabilities. You can prompt naturally, or ask your client to call bash with the direct command shown.

Start with `host-tools --brief` and `host-tools schema ` before using an unfamiliar trading or funding tool.
Feature What It Does Example Prompts Direct Command
Account State View account, margin, positions, open orders, and portfolio "show my perps positions" "what open orders do I have?" host-tools getHyperliquidPositions
Account Health Snapshot authenticated account exposure and margin "check my perps account health" host-tools perps.accountHealth includeExitEstimates=true
Markets List canonical Hyperliquid markets and asset metadata "show Hyperliquid markets" "what is BTC funding?" host-tools getHyperliquidMarkets
Market Radar Rank markets by activity and compare retained samples "radar for active perp markets" host-tools perps.marketRadar limit=10
Prices Fetch one or many live perps prices "BTC perps price" "price BTC ETH SOL" host-tools getHyperliquidPrice '{\"asset\":\"BTC\"}'
HIP-3 Discovery Search HIP-3 markets and list builder-deployed DEXes "search HIP-3 markets for CL" "list HIP-3 DEXes" host-tools perps.hip3.search query=CL
HIP-3 Prices Read venue-scoped HIP-3 prices "price CL on xyz" host-tools perps.hip3.price '{\"dex\":\"xyz\",\"coin\":\"CL\"}'
Orders Place market or limit orders "place a BTC limit order" "open a small ETH short" host-tools placeHyperliquidOrder '{\"asset\":\"BTC\",\"isBuy\":true,\"size\":0.01,\"orderType\":\"market\"}'
Stops Place stop-loss or take-profit style trigger orders "set a BTC stop loss" host-tools placeHyperliquidStopOrder '{\"asset\":\"BTC\",\"triggerPrice\":95000,\"size\":0.01,\"isBuy\":false}'
Order Management Cancel or modify open orders "cancel my open ETH order" "modify that limit order" host-tools cancelHyperliquidOrder '<json>'
Leverage & Margin Adjust leverage and isolated margin "set BTC leverage to 5x" "add isolated margin" host-tools adjustHyperliquidLeverage '{\"asset\":\"BTC\",\"leverage\":5}'
Funding Deposit or withdraw Hyperliquid USDC "deposit to Hyperliquid" "withdraw from Hyperliquid" host-tools depositToHyperliquid '<json>'
HIP-3 Funds Move collateral into or out of a selected HIP-3 DEX "fund xyz HIP-3 with 100 USDC" host-tools perps.hip3.fund '{\"providerContext\":{\"providerId\":\"hip3:xyz\"},\"amount\":\"100\"}'
Data Fetching Fetch trades, candles, and order books into sandbox tables "fetch BTC candles into SQL" host-tools fetchHyperliquidCandles '{\"coin\":\"BTC\",\"interval\":\"1h\"}'
SQL Analysis Query fetched perps data with DuckDB/SQLite-style workflows "query large BTC trades" sql query "SELECT * FROM <table> LIMIT 10"
Account health and market radar require a separately authorized [Perps MCP connection](/perps-mcp/client-setup) with `tools:execute`. They are not read tools in the Ask Gina listed plugin.

Account health

perps.accountHealth requires an authenticated account. It defaults to canonical Hyperliquid. Pass providerContext with {"providerId":"hip3:xyz"} for an enabled HIP-3 venue.

The response includes at most 64 positions. Set includeExitEstimates=true for indicative exit estimates on at most eight positions, not fill guarantees. The tool does not assign a health score or calculate historical performance.

Market radar

perps.marketRadar accepts limit from 1 to 50, defaulting to 10, and an optional dex, such as dex=xyz. Omit dex for canonical Hyperliquid.

Eligible markets rank by descending 24-hour traded volume, then open interest, then absolute 24-hour price change, with coin name breaking ties. This measures activity and exposure, not liquidity, depth, or executable size. Excluded-market details are capped at 100.

Rank, volume, open-interest, and mark-price deltas compare with a shared sample for that venue, not the caller's previous request. Samples rotate no more often than every five minutes and expire after seven days. Rows without a prior entry are marked firstSeen.

Radar returns the complete JSON response inline or in an artifact. It does not automatically extract the rows into SQL tables.

Discovery Flow

Use this sequence when you are unsure which tool to call:

{ "command": "capabilities --json" }
{ "command": "host-tools --brief" }
{ "command": "host-tools schema getHyperliquidPrice" }

HIP-3 Provider Context

For HIP-3 tools, prefer provider context over legacy venue-only inputs:

{
  "providerContext": {
    "providerId": "hip3:xyz"
  }
}

This keeps pricing, orders, margin, funding, and SQL analysis scoped to the selected HIP-3 provider.