Short Positions

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

Adds detailed return field breakdown (including market-specific fields), data sources (FINRA bi-weekly, HKEX daily), and interpretation of rate. Annotations already indicate read-only and idempotency, so description enriches beyond that.

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?

Compact yet comprehensive. Every sentence adds value: purpose, market inference, count, return fields with market-specific notes, and sources. No redundancy.

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 no output schema, the description fully explains the return data structure and market differences. Annotations cover safety and idempotency. All essential aspects are covered.

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%, and description adds clarity: symbol suffix inference, count range and default value (1-100, default 20) not fully captured in 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?

Clearly states it retrieves short interest history for HK/US stocks, with market inferred from symbol suffix. Distinguishes from sibling tools like short_margin and short_trades by focusing on open short positions history.

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 context on market inference and count defaults, but does not explicitly contrast with other short-related tools. However, the description gives enough details for the agent to decide when to use it.

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