get_northbound_flow

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

Annotations already declare readOnlyHint=true, openWorldHint=true, and idempotentHint=true, so the description does not need to restate safety. It adds behavioral context about direction and required parameters but does not disclose pagination behavior or output format beyond the schema.

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 structured with strategy tags, critical rules, examples, and an Args list. It is front-loaded with purpose. The Args section is somewhat redundant with the schema but provides clarity. Minor verbosity, but overall efficient.

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 has 7 parameters and an output schema, the description covers the key parameters (direction, scope, symbol, dates) and usage rules. It does not discuss pagination parameters (count, offset) but the output schema likely documents return values. The description is fairly complete for a data retrieval tool.

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?

With 0% schema description coverage, the description's Args section adds meaning for 5 out of 7 parameters (direction, scope, symbol, start, end). However, it omits count and offset, which are also in the schema. This partially compensates for the lack of schema descriptions.

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 retrieves northbound/southbound capital flow for Stock Connect. It distinguishes itself from sibling tools like get_capital_flow by specifying the Stock Connect context. The verb 'Get' and resource 'capital flow' are precise.

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 explicit guidance on using direction=north or south, and a critical rule for when scope=stock requiring symbol. While it doesn't explicitly mention when not to use the tool, the strategy tags provide clear usage context.

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