gangtise_realtime

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

No annotations provided, but description explains return behavior: non-trading hours return last trading day snapshot, suspended stocks return last valid snapshot. Lacks details on auth or rate limits but sufficient for a query 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?

Concise, front-loaded with main purpose, followed by key details. No unnecessary words. Every sentence adds information.

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?

Covers main use cases and edge cases, distinguishes from siblings. No output schema but return format is standard for snapshots. Slightly incomplete on pagination or limits, but adequate.

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 clear descriptions. Description adds value by explaining default behavior ('默认不传 = 返回全量字段') and when to use field parameter, plus requirement to include identifier fields.

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 clearly states the tool queries real-time market snapshots covering A/HK/US stocks with mixed codes. It specifies behavior during non-trading hours and for suspended securities, and distinguishes from k-line interfaces.

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?

Explicitly states when to use this tool vs. day-kline tools: '日 K 线接口不含盘中数据，问现在/此刻请走本工具.' Also covers edge cases like non-trading hours and suspended stocks.

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