Skip to main content
Glama

Order book

get_orderbook
Read-onlyIdempotent

Resting bids and asks for one market, best first, with the spread. Ask: "How deep is the BTC book?"

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "get_orderbook"
  }
}

Input Schema

NameRequiredDescriptionDefault
depthNolevels per side, 1-100 (default 20)
symbolNomarket symbol as get_markets lists it, e.g. BTC, ETH or ETHUSDT
pair_idNoor the market's pair id, e.g. 1

Output Schema

NameRequiredDescriptionDefault
asksNo
bidsNo
emptyNo
marketNo
spreadNo
networkYestestnet or mainnet
pair_idNo
summaryYesone plain sentence
best_askNo
best_bidNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and openWorldHint, so the safety profile is covered. The description adds useful behavior beyond that by noting only resting orders are returned, ordering is best-first, and the spread is included, but it says nothing about snapshot timing, behavior when requested depth exceeds available levels, or that symbol and pair_id are alternative selectors.

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?

One tight sentence carries scope, ordering, and the spread, followed by a short usage cue. Nothing is redundant and the most important information is front-loaded.

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 simple read-only lookup with rich annotations, a full output schema, and fully described parameters, the description covers what is needed to call it. The only gap is the unstated mutual exclusivity of symbol and pair_id and any note on truncated depth.

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 depth (1-100, default 20), symbol format, and pair_id are fully documented in the schema. The description adds no meaning beyond that, so the baseline of 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?

States a concrete resource and scope: resting bids and asks for one market, ordered best-first, including the spread. That is specific enough to separate it from get_trades or get_order by resource noun, though no sibling is named explicitly for contrast.

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

Usage Guidelines3/5

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

The quoted question '"How deep is the BTC book?"' implies the use case (checking liquidity/depth) but there is no explicit when-to-use vs. when-not guidance and no alternative tool is named for related needs such as single-order lookup or recent trades.

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.