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

Goes far beyond the read-only annotations: it discloses that northbound daily net flow has not been published since August 2024 and that net_flow fields state this explicitly rather than returning null, that southbound net flow is still disclosed, and that the northbound top-traded list relies on a flaky upstream report attempted live on every call. It also names the data sources and that access is keyless.

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?

Front-loaded with purpose, then limits, then sources — good ordering with no filler sentences. The top-traded-stocks caveat is somewhat long-winded relative to its importance, which costs it a point.

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?

With no output schema, the description carries the burden of describing returns and does so by naming actual field paths (net_flow, top_traded_stocks.northbound) and the channel breakdown. An agent knows what shape of answer to expect and why a field may be unavailable.

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?

There is only one optional parameter and schema coverage is 100%, with the schema itself documenting both accepted formats and the 'most recent published day' default. The description adds no date-format or timezone nuance beyond that, so it is baseline by design rather than deficient.

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 resource (Stock Connect daily channel statistics) with the exact measures returned (gross turnover, northbound/southbound, top traded stocks) and names the channel codes (沪股通/深股通/港股通). An agent can tell this apart from generic market-snapshot siblings without opening the schema.

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?

Four sample utterances ("northbound stock connect turnover today", "沪深股通成交额", etc.) make the use case unambiguous, and the net-flow caveat clarifies the limits of what can be asked. However, it never names a sibling alternative for the nearby cases (e.g. ashares_capital_flow or ashares_turnover_ranking for A-share flow/ranking), so routing is left implicit.

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