Broker Holding

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

The description adds behavioral context beyond the annotations by specifying the data source (HKEX CCASS participant disclosure) and that it returns 'top' holdings. This complements the readOnlyHint and other annotations without contradiction.

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 single, short sentence that conveys all essential information without extraneous text. It is front-loaded with the main action and resource.

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 presence of a full schema, annotations, and output schema, the description adequately covers the tool's scope, data source, and limitation to HK stocks. It is complete for a simple data retrieval tool with good structured metadata.

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 covers 100% of parameters with descriptions. The description adds general context (HK stocks) but does not describe the period parameter beyond what the schema already provides. Thus, the description adds little semantics over the schema.

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 action ('Get'), the resource ('top broker holding data'), and the constraint ('for a symbol (HK stocks only)'). It distinguishes from siblings like broker_holding_daily by specifying 'top' and the source (HKEX CCASS).

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 explicitly limits usage to HK stocks and identifies the data source, providing clear context. However, it does not explicitly mention when not to use or suggest alternative tools for other markets or full holding details.

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