get_shfe_rank_table

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

Annotations already declare readOnlyHint, idempotentHint and non-destructive behavior. The description adds value beyond these by disclosing the data start date, the daily update schedule, and the important constraint that only per-product rankings are published.

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?

Purpose and source links are front-loaded, followed by caveats and parameter notes. The return-field breakdown is verbose but justified given no output schema exists, and nothing is redundant.

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 tool with no output schema, the description thoroughly documents return fields (rank, party names, open interest, changes, symbol, var, date), both parameters, update timing, and scope constraints, giving an agent enough to call and interpret it 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?

Schema description coverage is 0%, so the description carries the burden and does so well: 'date' is documented as the trading day and 'vars_list' as a list of contract varieties whose empty value returns all commodities. This compensates for the undocumented schema 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?

States a specific verb and resource: the SHFE member trading and position ranking table. It names the exchange explicitly and explains the scope constraint (per-product, not overall). It does not explicitly differentiate from sibling rank tables like get_rank_table_czce or get_dce_rank_table, so it falls short of a 5.

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?

Provides practical context: data begins 20020107, updates each trading day around 16:30, and the exchange publishes rankings only within each product. However, there is no explicit when-to-use vs the sibling rank-table tools (CFFEX, DCE, CZCE), leaving selection to inference from the exchange name.

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