Skip to main content
Glama

get_orderbook

Retrieve bids and asks for a perpetual futures symbol across supported exchanges to inspect market depth, with no API keys required on most venues.

Instructions

Get the order book (bids and asks) for a symbol on an exchange. Works without API keys on every venue with an account API (configured credentials → the account adapter; none → the public endpoint / read-only adapter); market-data-only venues have no orderbook path. Hyperliquid: native perps only (HIP-3 dexes via the CLI --dex).

Input Schema

NameRequiredDescriptionDefault
symbolYesTrading pair symbol, e.g. BTC, ETH, SOL
exchangeYesExchange name: pacifica, hyperliquid, lighter, aster, lighter-rh, ondo, arcus, qfex, risex, txflow, variational, grvt, extended (aliases accepted)

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.15.0
    • changedInput schema / properties / exchange / description
      Previous value: -"Exchange name: pacifica, hyperliquid, lighter, aster, lighter-rh, ondo, arcus, qfex, risex, txflow (aliases accepted)"New value: +"Exchange name: pacifica, hyperliquid, lighter, aster, lighter-rh, ondo, arcus, qfex, risex, txflow, variational, grvt, extended (aliases accepted)"
  2. Changed1 schema field changedv0.14.3
    • changedInput schema / properties / exchange / description
      Previous value: -"Exchange name: pacifica, hyperliquid, lighter, or aster"New value: +"Exchange name: pacifica, hyperliquid, lighter, aster, lighter-rh, ondo, arcus, qfex, risex, txflow (aliases accepted)"
  3. Changed1 schema field changedv0.3.12
    • changedInput schema / properties / exchange / description
      Previous value: -"Exchange name: pacifica, hyperliquid, or lighter"New value: +"Exchange name: pacifica, hyperliquid, lighter, or aster"
  4. First observedv0.1.0

TDQS

A3.8/5.0
Behavior4/5

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

With no annotations present, the description carries the full burden and does well: it discloses credential-driven adapter routing, the keyless public fallback, read-only behavior, and a venue-specific limitation (Hyperliquid native perps only, HIP-3 dexes via the CLI --dex flag). It does not mention rate limits or the structure of what comes back, but the failure-mode disclosure is unusually strong for a read tool.

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

Conciseness4/5

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

One dense front-loaded sentence states the core purpose first, then appends routing and venue caveats as clauses. Nothing is filler, though the trailing Hyperliquid/--dex note is cryptic and packed into the same sentence.

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

Completeness3/5

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

For a multi-exchange tool with no annotations and no output schema, the description covers routing and availability risks well, but it never characterizes the returned book (level structure, depth, price/size format). The agent knows whether the call will work but not what it gets back.

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 both parameters are already documented in the schema (symbol examples, exchange name list). The description adds only venue-specific semantics around exchange, not syntax or format beyond the schema. Baseline 3 applies.

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

Purpose4/5

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

The description states a specific verb and resource — retrieve the bids-and-asks order book for a given symbol/exchange — which is unambiguous on its own. It does not explicitly contrast itself with near siblings like get_prices, get_outcome_book, or get_option_chain, so an agent must infer the differentiation from the exchange/symbol scope.

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?

It gives real usage context: works keyless on any venue with an account API, routes to the account adapter when credentials exist, and returns nothing on market-data-only venues. That is a clear when-it-works/when-it-fails statement. It stops short of naming an alternative tool for the cases it cannot serve.

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