github_rate_limit

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

No annotations are provided, so the description carries the full burden. It discloses the read-only nature ('Check') and the return structure, but it does not mention authentication requirements, potential network calls, or whether the tool itself consumes rate limit. A simple statement confirming no side effects would have increased transparency.

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 and front-loaded: a one-sentence purpose, a clear return description, and a usage example. Every line earns its place 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?

For a simple zero-parameter tool with an output schema, the description is complete enough. It explains the return keys and gives an example. It does not discuss error conditions or authentication nuances, but these are likely covered by the output schema and the tool's simplicity.

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?

This tool has zero parameters, so the baseline is 4. The description provides an example call with no arguments, which reinforces the schema. There is no need for additional parameter explanation.

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 a specific verb and resource: 'Check the current GitHub API rate limit status.' It is distinct from sibling tools like github_auth_status and other github_* tools, and it also specifies the return format.

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 implies usage (when you need rate limit status) but does not explicitly state when to use this tool versus alternatives or provide any exclusions. Since no alternative rate-limit tool exists among siblings, the lack of explicit guidance is not critical, but a clear 'use this when...' would have improved it.

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