hub_rate_limit

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

Discloses that it sends a HEAD request (not metered), reads RateLimit-Limit/RateLimit-Remaining headers, falls back to environment variables, and does not read ~/.docker/config.json. Annotations already indicate read-only and non-destructive, and description adds valuable context.

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?

Concise yet comprehensive: single-sentence summary, then technical details, then args/returns. Every sentence provides essential information 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?

Explains return fields (authenticated, limit, remaining, window_seconds, unlimited), handles edge case of no limit, and describes credential behavior. No output schema needed given the clear dict description.

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?

Describes each parameter's purpose: username overrides DOCKER_MCP_SERVER_REGISTRY_USERNAME, password overrides DOCKER_MCP_SERVER_REGISTRY_PASSWORD. Adds meaning beyond the default-only schema.

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?

Description states 'Report the caller's remaining Docker Hub pull-rate-limit budget' with a specific verb and resource, clearly distinguishing it from sibling tools like image_pull or hub_repo_info.

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?

Explicitly advises calling before large compose_pull or image_pull to avoid hitting the cap, and explains credential fallback. Provides clear when-to-use guidance.

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