SupplyMaven API Pro

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It effectively describes what the tool returns (the Transportation Services Index and related metrics) and its economic significance, though it lacks details on data freshness, rate limits, or error handling, which would elevate it to a 5.

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 front-loaded with the core purpose, followed by details on returns, economic context, and usage. Every sentence adds value—defining the index, listing components, explaining significance, and specifying user groups—with no wasted words.

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 tool's complexity (retrieving a multi-component index) and lack of output schema, the description is mostly complete—it details what's returned and why it's used. However, it could improve by specifying the format of the return data (e.g., time series, latest value) or any limitations, keeping it from a perfect score.

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 0 parameters with 100% schema description coverage, so the baseline is 4. The description appropriately adds no parameter details, as none are needed, and instead focuses on the tool's output and usage context.

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's purpose with specific verbs ('Get the US freight transportation health index') and resource ('from the Bureau of Transportation Statistics'), distinguishing it from siblings like 'get_economic_indicators' or 'get_rail_freight_status' by focusing specifically on the freight transportation index and its components.

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 explicitly states when to use this tool ('Used by logistics companies, freight brokers, and economic analysts tracking US freight demand trends') and provides context on its application ('Declining freight volumes are a leading indicator of economic slowdown'), offering clear guidance without needing to reference alternatives directly.

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