okx_get_put_call_ratio

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

No annotations provided; description only marks as [L:READ] and category. No details on data freshness, latency, or behavior under invalid parameters.

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?

Extremely short but cryptic and not informative. The structure uses markers that are not explained.

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 or annotations; description fails to explain what the ratio represents or how to interpret results. Highly incomplete given the complexity of options data.

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 descriptions; description adds no extra parameter meaning. Baseline 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?

Description is vague; includes category and prerequisite but does not explicitly state that it retrieves the put/call ratio. The name suggests the function but the description lacks clarity.

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?

Includes a prerequisite ('call agent_catalog first') but no guidance on when to use this vs. sibling tools like okx_get_open_interest or okx_get_option_oi_ratio.

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