okx_get_long_short_ratio

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

No annotations are provided, so the description bears full responsibility. The 'L:READ' tag suggests read-only, but no further behavior (e.g., rate limits, data range, response structure) is disclosed. This is insufficient for a data retrieval tool.

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 very concise (one line) but lacks substantial content beyond tags and a prerequisite. It earns its place but sacrifices completeness for brevity.

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?

No output schema and minimal description. The tool has 3 parameters (1 required) and is in a context of many similar tools. The description does not provide enough information for an agent to confidently use it without additional inference.

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 coverage is 100% with each parameter having a description in Chinese. The description does not add extra semantic meaning beyond the schema (e.g., examples or formatting hints). Baseline 3 is appropriate given high coverage.

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 states 'L:READ' and 'CAT:[Statistics]' but does not explicitly state that the tool retrieves the long/short ratio for a given currency. The name is clear, but the description relies on it. Sibling tools like okx_get_top_trader_long_short_ratio exist, but no differentiation is provided.

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 mentions '→ 请先调用 agent_catalog' (please call agent_catalog first), indicating a prerequisite. However, it gives no guidance on when to use this tool vs. alternatives like okx_get_contracts_long_short_ratio or okx_get_long_short_account_ratio.

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