stock_hk_index_spot_sina

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

Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false. The description adds valuable context beyond these: heavy usage may get the IP banned, with a recommended retry delay. It also discloses the return type as pandas.DataFrame. This enriches the behavioral profile meaningfully.

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 compact and includes only relevant details: source, resource, data type, return format, and a critical usage warning. The URL and title are somewhat redundant with the name and description, but they do not significantly bloat the text. The structure is clear and easy to parse.

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?

For a no-parameter, read-only tool with strong annotations, the description covers the core essentials: what it returns (real-time index quotes), from where (Sina Finance), and the return type (DataFrame). It also adds operational context about IP bans. There is no output schema, so the return type hint is useful. The only missing element is explicit differentiation from similar sibling 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?

The tool has zero parameters, so the baseline is 4. The description adds semantic meaning by stating '所有指数' (all indices), making clear the tool returns data for all HK indices without filtering. No parameter documentation is needed.

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 returns real-time market data ('实时行情数据') for all Hong Kong stock indices from Sina Finance ('新浪财经'). The noun and scope are specific, and the source is named. However, it does not explicitly distinguish this from the sibling tool stock_hk_index_spot_em, which likely serves the same purpose from a different data provider.

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 includes an operational guideline: mass requests can lead to IP bans, and users should wait 10 minutes if banned. It does not, however, provide guidance on when to choose this tool over alternatives like stock_hk_index_spot_em, nor does it mention any prerequisites or context for typical use.

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