spot_hog_soozhu

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

Annotations already declare readOnlyHint, openWorldHint, idempotentHint, and non-destructive behavior. The description adds the data source URL and return type (pandas DataFrame), but does not disclose additional behavioral details like update frequency or data limitations. With annotations present, this is acceptable but not rich.

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 compact and includes only essential information: the tool's scope, source URL, return value, and return type. The `:return:` and `:rtype:` lines are standard docstring elements and add structure without redundancy.

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 zero-parameter tool with rich annotations, the description is adequately complete. It identifies the data source, the nature of the data (real-time provincial average price ranking), and the return format. While it does not enumerate DataFrame columns, this is not critical given the tool's simplicity and the absence of an output schema.

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 tool has zero parameters and the schema coverage is 100% (empty schema). Per guidelines, the baseline for 0 params is 4. The description correctly indicates no parameters are needed, and no further parameter explanation is required.

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 the tool returns a real-time ranking of average hog prices by province from Soozhu, with a specific source URL and return type. It distinguishes itself from sibling hog tools by focusing on province-level average price rankings, though it lacks an explicit verb like 'get' or 'fetch'.

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?

No guidance is provided on when to use this tool versus alternative hog-data tools such as spot_hog_crossbred_soozhu or index_hog_spot_price. The description is purely descriptive and does not mention use cases or exclusions.

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