getVipMarginData

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

Since no annotations are provided, the description carries the full burden. It discloses that the endpoint is public and requires no authentication. It also notes the deprecation of the collateralRatio field. While it doesn't mention rate limits or other constraints, it covers key behavioral traits for a read-only query tool.

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 relatively concise, but the 'Agent hint' partially repeats information about the deprecated field and usage. However, it remains front-loaded with the core purpose and is not overly verbose.

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 two optional parameters and no output schema, the description provides adequate context: purpose, return fields, deprecation notice, and authentication requirement. It doesn't explain the return format, but for a query tool this is acceptable without an output schema.

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 description coverage is 0%, so the description must compensate. It mentions the parameters 'vipLevel' and 'currency' only in passing ('by VIP level and/or coin'), without explaining their types, allowed values, or defaults. This leaves significant ambiguity, especially since both parameters are optional.

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 queries margin data for Unified accounts by VIP level and/or coin. It lists specific return fields like borrowing availability, interest rates, collateral settings, and liquidation order. This distinguishes it from siblings like getCollateralInfo or getTieredCollateralRatio.

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 an 'Agent hint' that explicitly tells when to use the tool (to check borrowing terms) and when not to (the collateralRatio field is deprecated, suggesting use of getTieredCollateralRatio instead). This provides clear guidance and alternatives.

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