okx_get_contracts_long_short_ratio

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

No annotations are provided, so the description carries the full burden. It only notes a read operation via '[L:READ]' and a category, but does not disclose any behavioral traits such as rate limits, data freshness, or side effects. This is insufficient for understanding the tool's behavior.

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, consisting of a single line with bracket notation. It efficiently communicates the category and a prerequisite. No words are wasted, though the structure is minimal.

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?

The tool has no output schema, and the description does not explain what the tool returns. Given the complexity of retrieving contract long/short ratios, the description should provide information about the response format or data fields. The current description is incomplete for an agent to fully understand the tool's output.

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 (ccy, end, begin) having a description in the input schema. The description does not add any additional meaning beyond the schema, so baseline score of 3 is appropriate.

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 tool name 'okx_get_contracts_long_short_ratio' clearly indicates it retrieves the long/short ratio for contracts. However, the description '[L:READ] CAT:[统计] | → 请先调用 agent_catalog' does not explicitly state the purpose; it only adds a category and a prerequisite. The purpose is implied but not clarified beyond the name.

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 instructs to call 'agent_catalog' first, providing some context about a prerequisite. However, there is no guidance on when to use this tool versus numerous sibling tools like 'okx_get_long_short_ratio' or 'okx_get_contract_trader_ls_ratio'. No exclusions or alternatives are mentioned.

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