hub_rate_limit

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

The description adds significant context beyond annotations: it explains the HEAD request is non-metered, how credentials affect limits, fallback to environment variables, and handling of unlimited plans. Annotations already indicate read-only and non-destructive, so the description enriches understanding without contradiction.

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 well-structured and front-loaded with the main purpose. Each subsequent sentence provides vital details: how the check works, when to use it, credential handling, and return format. There is no wasted text; every sentence contributes to understanding.

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 complexity and that there is no output schema, the description provides return dict fields explicitly. It covers parameters, usage advice, and credential details. Minor omissions like error handling (e.g., network failure) do not detract significantly, making it almost 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 0% description coverage (no parameter descriptions), so the description fully compensates by explaining each parameter: 'username - Optional Hub username (overrides ...)' and 'password - Optional Hub password/token (overrides ...)'. This adds essential meaning that the schema lacks.

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 it 'reports the remaining Docker Hub pull-rate-limit budget,' specifying the verb 'report' and the resource 'rate limit.' It distinguishes from sibling tools like image_pull and compose_pull by noting that this is a check before a pull, not a pull itself.

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 advises to call it 'before a large compose_pull/image_pull to avoid hitting the cap mid-deploy.' While it does not list explicit when-not-to-use cases, it provides clear context for when it is beneficial. No alternative tool is mentioned, but the scope is well-defined.

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