hyperevmAccountState

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

With no annotations, the description must fully convey behavioral traits. It indicates a read-only 'get' operation returning collateral, debt, and health metrics, but does not disclose if it triggers state changes, rate limits, or authentication requirements. The description is adequate but lacks depth.

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 sentence that efficiently communicates the tool's purpose and scope without extraneous words. It is front-loaded with 'Get comprehensive overview' and includes concrete elements (collateral, debt, health metrics).

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?

For a simple query tool with two optional parameters and no output schema, the description provides enough context for an agent to use it correctly. It covers the return content broadly. Minor improvement would be mentioning that userAddress defaults to the wallet address, but that is already in the 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 100% for both parameters (detailed, userAddress), so the description does not need to add parameter details. It does not provide any parameter-specific context beyond the schema, meeting the baseline.

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 a comprehensive overview of a HyperLend position, specifying the included assets (collateral, debt, health metrics). This distinguishes it from sibling tools like hyperevmSupply or hyperevmBorrow which perform specific actions.

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 implies this tool is for checking overall position health, but does not explicitly state when to use it versus alternatives (e.g., hyperevmGetReserves for reserve-level data). No exclusions or prerequisites are mentioned.

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