Skip to main content
Glama

Get orderbook

get_orderbook
Read-only

Get the live orderbook (bids/asks) for a market, optionally truncated to a depth.

Input Schema

NameRequiredDescriptionDefault
depthNoMax levels per side
marketYesMarket ticker, e.g. BTC-USD

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / market / pattern
      Added value: +"^[A-Z0-9]{1,20}-[A-Z0-9]{1,20}$"
  2. First observed

TDQS

A3.6/5.0
Behavior3/5

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

readOnlyHint=true already tells the agent this is a safe read, so the bar is lower. The description adds that the data is 'live' and that depth truncation is optional, but it does not disclose rate limits, pagination, or return shape. That is modest added value over the annotation.

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?

A single front-loaded sentence with no filler. Every clause (live, bids/asks, for a market, optional depth) carries information and nothing is redundant.

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?

For a read-only tool with full schema coverage and a readOnlyHint annotation, the description covers the essentials: what is returned and the optional truncation. It stops short of describing return structure or rate limiting, which is a minor gap given there is no output schema.

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%: both 'market' and 'depth' are documented in the schema, including the depth max and exclusivity. The description's 'optionally truncated to a depth' merely restates the schema, so baseline 3 applies.

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 verb (Get) and resource (live orderbook) with the data shape (bids/asks), the scoping parameter (for a market), and the optional truncation. It is easily distinguished from siblings like get_market (metadata) and get_candles (OHLC).

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

Usage Guidelines2/5

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

The description says what the tool returns but gives no when-to-use guidance, no alternatives, and no exclusions relative to sibling market-data tools such as get_market or get_candles. Usage is only implied by the resource name.

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