get_snapshot

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

No annotations are provided, so the description must bear the full burden. It states 'no subscription needed' (a behavioral note) and lists the data fields returned. However, it does not mention rate limits, data freshness, or other behavioral traits, leaving gaps.

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 a single, efficient paragraph with no wasted words. It front-loads the core purpose, then provides usage guidance and parameter details, making it easy to scan.

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 simple tool (one parameter, no output schema), the description covers purpose, usage triggers, parameter format, and constraints. It is sufficiently complete for an agent to select and invoke this tool correctly.

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 has only one parameter 'codes' with no description. The description adds value by giving example formats (US.AAPL, HK.00700, SH.600519) and a usage limit (up to 400 codes), which goes beyond the schema's bare type definition.

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 explicitly states the tool retrieves a market snapshot with specific data (latest price, OHLC, volume, bid/ask) for one or more stocks. The verb 'Get' and resource 'market snapshot' are clear, and the mention of 'no subscription needed' distinguishes it from siblings that might require subscriptions.

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 provides clear usage triggers: 'Use when the user asks for 报价/价格/行情/快照/quote/price/snapshot.' It also gives code format examples and a limit of 400 codes per call. It lacks explicit exclusions or alternatives but is sufficient for guidance.

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