ramzinex_get_orderbook

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

No annotations exist, so the description bears the burden. It states the operation is public and requires no auth, implying a read-only, non-destructive behavior. However, it doesn't disclose error handling, data freshness, or any limits, which would strengthen transparency.

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?

The description is extremely concise: a one-line purpose, Persian translation, endpoint mapping, and parameter list. Every sentence adds value with no fluff. Well-structured.

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?

Given the presence of an output schema (not shown), the description need not detail return values. It covers the core purpose, parameters, and public nature. It could mention that both buy and sell sides are returned, but the name already implies that. Overall, sufficiently complete for its context.

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?

Input schema had 0% description coverage, but the description adds clear meaning for both parameters: pair_id is 'Numeric id of the pair' and instance is 'Configured instance whose public base URL to use'. This compensates well for the schema gap.

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 the tool fetches the buy/sell orderbook for a single pair. It differentiates from sibling tools like ramzinex_get_orderbook_buys, ramzinex_get_orderbook_sells, and ramzinex_get_all_orderbooks by specifying 'single pair' and including both sides.

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?

The description notes 'Public, no auth' and provides the HTTP endpoint, but does not explicitly compare when to use this vs the separate buys/sells tools. Usage context is implied by the name and Persian text, but no explicit when/when-not guidance is given.

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