getSpreadOrderbook

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

Given no annotations, the description fully explains behavior: returns up to 25 levels per side, bid/ask sorting, u field for correlation, no auth required. It also explains default limit behavior and return fields.

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

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

Well-structured with intro, bullet points, notes, and agent hint. However, some repetition exists between usage points and agent hint. Still concise overall with no fluff.

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

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

Without output schema, the description explains return fields (bid/ask levels, sequence, timestamp) and ordering. It also covers correlation with WebSocket and default limit. Sufficient for an AI agent to use correctly.

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

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

Schema has 0% description coverage, so the description compensates fully. It explains symbol must be valid spread combination (with reference to getSpreadInstrumentsInfo) and limit default=1 for best bid/ask, with range up to 25.

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

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

The description clearly states it retrieves spread orderbook depth data for a specific spread symbol, with specific verb 'Retrieve'. It distinguishes from siblings like getSpreadTickers by explicitly stating what not to use it for.

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

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

Explicit usage scenarios are listed ('when you need to... inspect current bid/ask depth, fetch best bid/ask, correlate with WebSocket'). Also includes explicit 'Do not use' with alternative tool (getSpreadTickers). Agent hint provides additional guidance on symbol and limit.

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