github_auth_status

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

With no annotations provided, the description takes on the responsibility of explaining behavior. It discloses that the tool returns whether a token is configured and, if so, the authenticated user's login name, including the exact keys in the returned dict. This is transparent about output, though it does not mention potential network calls, errors, or side effects—minor for a status check.

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 well-structured: a one-sentence summary, a brief return description, and a clear example. Every line contributes useful information without redundancy, and the most important details are front-loaded.

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 zero-parameter tool with an output schema, the description is complete. It explains the purpose, the exact return structure, and includes an example. There is no missing information about inputs or outputs that would hinder an agent from using it correctly.

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 the baseline is 4. The description appropriately includes an example call with no arguments, confirming that no inputs are needed. There is nothing more to clarify since the schema is already empty and fully covered.

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 function with a specific verb and resource: 'Check GitHub authentication status and token validity.' It also indicates what it returns, distinguishing it from the many other GitHub-related tools in the sibling list, which focus on issues, PRs, repos, and rate limits.

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 the tool should be used to verify authentication, but it does not explicitly say when to use it relative to other GitHub tools, nor does it mention any prerequisites or exclusions. For example, it could advise checking auth status before operations that require a token, but no such guidance is given.

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