Get Smart Order

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

With no annotations, the description discloses the authentication requirement (POLONIEX_API_KEY and POLONIEX_API_SECRET) and implies a read operation through 'Fetch.' However, it does not describe behavior for error cases, what happens if both or neither id is provided, or any rate limits.

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 two concise sentences, front-loaded with the action ('Fetch a single smart order'), and every sentence provides necessary information without redundancy.

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?

For a simple read tool with complete schema descriptions and no output schema, the description covers the essential purpose, parameter constraint, and auth requirement. It could add edge-case behavior (e.g., not found) but is otherwise adequately complete.

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?

The input schema fully describes both parameters, but the description adds the critical "exactly one" constraint, which the schema does not enforce (since both are optional). This extra guidance helps avoid misuse and is valuable beyond the structured schema.

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's function: 'Fetch a single smart order by its order id or client order id.' It uses a specific verb and resource, and the mention of 'smart order' distinguishes it from sibling tools for regular orders and smart order lists/history.

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 provides clear context for a single-order fetch and adds an explicit parameter constraint ('provide exactly one'), but it does not mention when to use this tool versus alternatives like get_smart_open_orders or get_smart_orders_history, nor does it state exclusions.

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