okx_get_long_short_ratio_all

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

No annotations are present, so the description carries the full burden. It only includes '[L:READ]' suggesting read access, but does not disclose other behavioral traits (e.g., auth requirements, data scope, rate limits). The description adds minimal behavioral context.

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 short (two short phrases) but fails to convey key information. It is under-specified rather than concise. Every sentence should earn its place, but here the text is insufficient for the tool's purpose.

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 3 optional parameters, no output schema, and many similar sibling tools, the description is incomplete. It does not explain what the tool returns or how it differs from alternatives. The note to call agent_catalog suggests a dependency but does not complete the picture.

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 covers all three parameters with descriptions (100% coverage), so the description does not need to repeat them. It adds no additional meaning or context about parameters beyond the schema. Baseline score is 3.

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 only contains a category label '[L:READ] CAT:[统计]' and a note to call agent_catalog. It does not state what the tool does (e.g., 'get long/short ratio for all coins'). The name suggests functionality, but the description is vague and does not clarify the verb or resource.

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?

No guidance is provided on when to use this tool versus siblings like okx_get_long_short_ratio or okx_get_contracts_long_short_ratio. The only instruction is to call agent_catalog first, which is a prerequisite but not a usage guideline for selection.

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