Github User Info

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

Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, covering the safety profile. The description adds that the metadata is 'public', implying no authentication is needed, which is useful. No additional behavioral traits (e.g., rate limits, response shape) are disclosed, but the annotations carry the main burden.

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?

A single sentence that is front-loaded with the action verb and resource. Zero filler words; every word earns its place. Ideal conciseness.

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 simplicity (one param, annotations covering safety) and the presence of an output schema (not shown), the description is nearly complete. It lacks any mention of edge cases or limitations, but for a straightforward public GitHub profile lookup, nothing essential is missing.

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 schema has only one parameter (username) with 0% description coverage. The description says 'for a user' but doesn't explicitly state that the 'username' parameter is the GitHub username or provide format details. Since the parameter is self-explanatory and simple, this is adequate but does not add meaningful semantics beyond the 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?

The description states a specific verb ('Get'), resource ('public GitHub profile metadata'), and target ('for a user'). This clearly distinguishes it from siblings like github_user_repos (which returns repositories) and github_commit_emails (emails from commits). An agent can immediately understand the tool's function.

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 does not explicitly state when to use this tool versus alternatives like github_user_repos or github_commit_emails. However, the tool name and simple description make its purpose self-evident, and the sibling context suggests it's the primary profile-metadata lookup. Lacks explicit exclusions or alternative routing.

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