okx_ws_subscribe

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

With no annotations, the description carries the full burden, but it offers minimal behavioral context: only a [L:READ] tag implying non-destructive nature. No side effects, authentication, rate limits, or state management are disclosed.

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 short (one line) and front-loaded with the read hint and category, but the structure is cryptic and lacks proper sentences. It sacrifices clarity 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?

Given the complexity of a WebSocket subscription tool with 33 channels and 3 parameters, the description is grossly incomplete. It fails to explain subscription lifecycle, how to unsubscribe, or how this tool relates to sibling websocket tools.

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%, so baseline is 3. The description does not add any extra meaning beyond the schema's parameter descriptions. It provides no insight into parameter interactions or formatting nuances.

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 indicates it's a read operation for market data WebSocket (行情-WS) and suggests a prerequisite (agent_catalog), but does not explicitly state the tool's function of subscribing to WebSocket channels. This vagueness leaves room for confusion, especially when compared to sibling tools like okx_ws_subscribe_private.

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 alternatives such as okx_ws_events or okx_ws_subscribe_private. The only hint is to call agent_catalog first, which is a prerequisite but not a usage condition.

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