getPredictionPositionList

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

No annotations exist, so description bears full burden. It discloses that positions are open/unresolved only, includes details like shares held, market value, P&L, and event info. Does not mention rate limits or authentication beyond 'authenticated user', but is transparent about read-only nature and content.

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 somewhat lengthy but each sentence adds value: purpose, return content, usage guidelines, and agent hint. Could be slightly more concise, but no waste.

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?

No output schema, but description explains position contents well. Covers purpose, context, and usage, but lacks parameter documentation. For a tool with 3 optional params, the agent needs more detail to use them correctly.

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?

Input schema has 3 optional parameters (limit, direction, pageIndex) with 0% schema description coverage. The description does not explain any parameter meanings, usage, or how they affect the query. This is a significant gap for the agent.

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 'Query the authenticated user's current open prediction positions' with a specific verb and resource. It distinguishes from sibling tool getPredictionPositionHistory by noting 'For historical positions, use getPredictionPositionHistory'.

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?

Provides explicit guidance: 'AI agent should call this before placing a sell order to confirm the user holds sufficient shares, and to display the current portfolio.' Also gives an alternative for historical positions and specific advice to 'Check availableSize before selling.'

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