getPortfolioMargin

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

With readOnlyHint and openWorldHint already present, the description still adds meaningful behavioral context: the endpoint requires authentication and the default behavior when baseCoin is omitted. These details go beyond the annotations and help the agent predict the call's behavior.

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 clear sentence followed by two brief notes; the core purpose is front-loaded and every sentence adds value. There is no redundancy or filler.

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 read-only query with one optional parameter and no output schema, the description covers purpose, key returned fields, authentication, and default parameter behavior. It is reasonably complete, though a note on response shape would further reduce ambiguity.

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 has no description for baseCoin, so the description's note that omitting it returns all base coins provides useful partial semantics. It explains optionality and default scope, though it does not elaborate on accepted coin identifiers or formatting.

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 opens with 'Query the portfolio margin information' and enumerates the included data (wallet balance, margin rates, asset PNL range), so an agent can tell what resource is being accessed. It is clear, but it does not explicitly differentiate this tool from related siblings such as getWalletBalance or getVipMarginData.

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 notes state that authentication is required and that omitting baseCoin returns all base coins, which gives important invocation context. However, there is no guidance on when to choose this tool over alternatives or when not to use it, so usage is only implied by the purpose.

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