getSpreadMaxQty

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

Annotations already declare readOnlyHint=true, so the query nature is established. The description adds useful behavioral detail beyond annotations: authentication is required, and the returned ab value is truncated to 8 decimal places rather than rounded. This gives the agent meaningful expectations about how the tool behaves.

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 and well-structured: a one-sentence purpose followed by two focused bullet points. Every sentence adds value, and the most important identity information is front-loaded.

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?

With no output schema and no parameter descriptions in the schema, the description should explain all required inputs and the meaning of the result. It leaves orderPrice unexplained, does not define the side values, and only partially describes the output via the 'ab' truncation note. The tool is simple, but the documentation is incomplete for reliable invocation.

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 carry the burden of explaining parameters. It clarifies symbol and side in a general way, but it does not explain the required orderPrice parameter at all, nor does it define the side enum values ('1' and '2'). This is a significant gap for an agent trying to invoke the tool correctly.

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 states a clear action: 'Query the spread wallet available balance' for a symbol and side, which distinguishes it from other spread-related tools. However, it omits the required orderPrice parameter from the stated purpose, and the name says 'MaxQty' while the description says 'available balance', leaving slight ambiguity about the exact returned quantity.

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 it is used when querying the spread wallet's available balance for a symbol and side, and it notes the authentication requirement. It does not explicitly state when to prefer this tool over alternatives such as getWalletBalance or other spread-related getters, so usage guidance is only implicit rather than explicit.

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