uw_flow

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

Annotations already declare readOnlyHint, openWorldHint, and idempotentHint. The description adds context about the types of flow data and filtering options, which helps the agent understand what to expect without contradicting the annotations.

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 moderately structured with actions listed and notes on groups and filtering. However, it is somewhat verbose and could be more concise with clearer front-loading of essential information.

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?

Given the lack of an output schema, the description should clarify the return format of each action. It describes what each action retrieves but not the structure. For a data retrieval tool, this is adequate but not complete.

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 input schema has zero parameters, yet the description mentions several required parameters (e.g., date, flow_group, expiry) for specific actions. This creates confusion and inconsistency, undermining the usefulness of the description for parameter understanding.

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 identifies the tool as accessing UnusualWhales options flow data and enumerates specific actions (e.g., flow_alerts, full_tape). This distinguishes it from sibling tools focusing on other data types like alerts, congress, or darkpool.

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?

While the description lists the available actions, it does not provide explicit guidance on when to use this tool over siblings or when to avoid it. Usage is implied by the mention of options flow data, but no exclusions or alternatives are given.

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