index_realtime_sw

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

Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, so the safety profile is clear. The description adds a source URL and return type (pandas.DataFrame), but no further behavioral details such as data freshness, pagination, or potential errors, which is acceptable given the annotations.

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 compact docstring with a title, source URL, parameter specification, and return type. Each element provides necessary information with no redundancy, making it easy to scan and understand.

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 tool's simplicity (one parameter, no output schema), the description provides the essential parameter choices, return type, and data source. It does not describe DataFrame contents or update frequency, which could be useful but are not critical for basic realtime quote retrieval.

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 schema provides only a 'symbol' parameter with no description, and schema coverage is 0%. The description fully compensates by listing the exact allowed values (市场表征, 一级行业, 二级行业, 风格指数, 大类风格指数, 金创指数) and stating the parameter type as string, which is essential for correct invocation.

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 identifies the tool as providing realtime market data for the Shenwan Hongyuan index series (指数系列实时行情数据) with a specific source URL. However, it lacks an explicit verb like 'fetch' or 'retrieve', and does not explicitly differentiate from sibling index tools, though the name and context imply it.

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 for when to use this tool over alternatives. The description only lists parameters and return type, with no 'use when' or comparison to the many sibling index tools, leaving the agent to infer usage from the name and context.

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