getPortfolioMargin

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

No annotations provided, so description carries full burden. It states authentication is required and maps to an internal API. It implies read-only via 'Query', but does not explicitly declare read-only or mention rate limits or side effects.

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 concise: one lead sentence and two bullet notes. No redundant information, front-loaded with purpose.

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 with one optional parameter, the description covers purpose, parameter behavior, authentication, and internal mapping. It mentions the return includes wallet balance, margin rates, and asset PNL range, which is sufficient. Could elaborate on response structure, but not essential.

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 0%, so description compensates. It explains that baseCoin is optional and that omitting it returns all base coins, adding value beyond the schema's type definition.

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 it queries portfolio margin information including wallet balance, margin rates, and asset PNL range. It uses the verb 'Query' with a specific resource. While it doesn't explicitly distinguish from sibling get* tools, the purpose is well-defined.

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 context: authentication required, baseCoin behavior (optional, returns all if omitted). However, it does not specify when to use this tool versus alternatives like getWalletBalance or getAccountInfo.

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