macro_usa_api_crude_stock

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

Annotations already declare readOnlyHint=true, openWorldHint=true, idempotentHint=true, and destructiveHint=false. The description adds the return type (pandas Series with current value in 10k barrels) and the data range, which are useful context beyond what annotations provide. It does not disclose update frequency or limitations, but for a simple read-only fetch this is acceptable.

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, consisting of a title-like phrase, two reference URLs, and return type info. It is front-loaded with the report name and data range, with no redundant wording. The URLs are extra but not excessive for a data source reference.

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 parameterless macro data tool, the description covers the essential aspects: the report type, historical range, and return format. With annotations providing safety context and no output schema needed, this is reasonably complete. The only gap is update frequency, which is a minor omission.

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, so schema coverage is trivially 100%. Per the rubric, 0 params scores a baseline of 4. The description adds no parameter details, but none are needed.

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 that the tool provides the US API crude oil inventory report, specifies the data range from 20120328 to present, and describes the return as the current value in ten-thousand barrels as a pandas Series. This is a specific verb+resource that distinguishes it from sibling tools like macro_usa_eia_crude_rate by explicitly naming 'API'.

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 does not explicitly state when to use this tool versus other macro data tools, though the name and content imply it is for US API crude oil inventory data. No alternatives or exclusions are mentioned, so usage context is implied rather than clearly guided.

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