Skip to main content
Glama

Get L2 order book

hl_get_orderbook
Read-onlyIdempotent

Retrieve Level-2 order book data for a perpetual coin, showing top bid/ask levels with price, size, and order count, plus spread and mid price. Use for market microstructure and liquidity analysis.

Instructions

Level-2 order book for a coin: top-N bid/ask levels with price, size, and order count, plus spread and mid. Use for microstructure, spread, and near-touch liquidity. If the coin is unknown, call hl_get_markets first.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
coinYesPerp coin symbol, e.g. 'BTC' (case-insensitive).
depthNoNumber of levels per side.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
asksYes
bidsYes
coinYes
timeYes
midPxYes
spreadYes
spreadBpsYes
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false. Description adds no new behavioral traits beyond what annotations provide, but does not contradict them.

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?

Two sentences, no waste. First sentence defines output, second gives usage guidance and alternative. Perfectly front-loaded and efficient.

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

Completeness4/5

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

Given low complexity (2 params, output schema exists, annotations present), description covers purpose, usage, and fallback. Lacks mention of real-time nature or update frequency, but overall adequate.

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

Parameters3/5

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

Schema description coverage is 100%, so baseline 3. Description does not add significant information beyond the schema's parameter descriptions.

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?

Clearly states it provides Level-2 order book for a coin with specific data (top-N bid/ask levels, price, size, order count, spread, mid). Distinguishes from siblings by specifying use for microstructure and liquidity analysis.

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?

Explicitly says when to use (microstructure, spread, near-touch liquidity) and provides an alternative action if coin is unknown (call hl_get_markets). Lacks explicit 'when not to use' but context from siblings is reasonable.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/johnsmithxy1mmm-sys/HyperliquidMCP'

If you have feedback or need assistance with the MCP directory API, please join our Discord server