Skip to main content
Glama

get_hyperliquid_order_book

Live order book for one Hyperliquid perp (core or HIP-3, e.g. BTC or xyz:NVDA) or, with market=spot, one spot pair: up to 20 levels a side, mid, spread, and USD resting within 0.5%, 1% and 2% of mid. Pass sizeUsd to see the average fill and price impact of a market buy and sell of that size. Use it before sizing an order or to compare liquidity across coins.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "symbol": "<symbol>"
    },
    "name": "get_hyperliquid_order_book"
  }
}

Input Schema

NameRequiredDescriptionDefault
marketNoDefault perp. spot reads the spot pair's book
symbolYesCoin symbol, e.g. BTC or xyz:NVDA. With market=spot: HYPE, HYPE/USDC or @107
sizeUsdNoOptional order size in USD for the price impact estimate
nSigFigsNoGroup prices to this many significant figures to see deeper into the book (default: full precision)

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • addedInput schema / properties / market
      Added value: +{
      +  "description": "Default perp. spot reads the spot pair's book",
      +  "enum": [
      +    "perp",
      +    "spot"
      +  ],
      +  "type": "string"
      +}
    • changedInput schema / properties / symbol / description
      Previous value: -"Coin symbol, e.g. BTC or xyz:NVDA"New value: +"Coin symbol, e.g. BTC or xyz:NVDA. With market=spot: HYPE, HYPE/USDC or @107"
  2. Added

TDQS

A4.5/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations, so the description carries the full burden and does well: it discloses the 20-level depth cap, the computed liquidity bands, and that sizeUsd returns both a market-buy and market-sell average fill and price impact. It does not state read-only status, rate limits, or error behavior for invalid symbols, leaving some behavioral gaps.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Three dense sentences, front-loaded with scope and followed by output contents and the decision-relevant use case. No filler or repetition of the schema.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

There is no output schema, so the description's enumeration of returned fields is essential and present. Combined with full parameter documentation, an agent has everything needed to call it correctly for a read-only market-data tool.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the baseline is 3; the description still adds value by showing symbol formats including HIP-3 dex-prefixed coins (xyz:NVDA) and clarifying that sizeUsd yields both buy-side and sell-side impact estimates rather than a single number. nSigFigs is left entirely to the schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific resource (live order book) with an explicit scope: one Hyperliquid perp or, with market=spot, one spot pair. The enumerated outputs (20 levels a side, mid, spread, USD resting bands) make the tool unmistakable against siblings like get_hyperliquid_market or screen_hyperliquid_markets.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives concrete when-to-use guidance: 'before sizing an order or to compare liquidity across coins.' It does not name specific alternatives (e.g., get_hyperliquid_market for metadata vs. this for depth), so the routing is implied rather than explicit.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources