Broker Holding Detail

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so the agent knows it's safe. The description adds behavioral context beyond annotations by specifying the data source (HKEX CCASS) and the exact return structure, which helps the agent understand the nature of the data.

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 one sentence that front-loads the purpose, includes constraints, source, and output format. Every piece of information is necessary and efficiently conveyed.

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 only one parameter and an output schema described, the description is complete for an agent to invoke correctly. It covers input requirements (symbol), constraints (HK only), source, and output fields.

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 coverage is 100% with a description for 'symbol', but the description adds significant semantic value by specifying the permissible universe ('HK stocks only'), which is not in the schema (which only says 'Security symbol').

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's purpose with a specific verb ('Get'), resource ('broker holding detail list'), and scope ('for a symbol, HK stocks only'). It also distinguishes from siblings like broker_holding and broker_holding_daily by emphasizing it returns a detailed list with structure.

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 provides clear context by specifying that the tool is for HK stocks only and sourced from HKEX, which guides appropriate use. However, it does not explicitly mention when to use this tool over siblings like broker_holding or broker_holding_daily.

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