Github Search User

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

The annotations already cover the safety profile (read-only and non-destructive), but the description adds no behavioral detail beyond the implementation note 'using GraphQL API'. It does not mention exact vs partial match semantics, error or no-result behavior, rate limits, or authentication requirements.

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 one concise, front-loaded sentence with the verb and resource clear. The 'using GraphQL API' clause is unnecessary implementation detail, but it does not significantly harm clarity.

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 one-parameter, read-only lookup with an output schema present, the description is nearly sufficient. It lacks a brief scoping note such as whether this searches public users or requires authentication, but the annotations and output schema carry most of the remaining burden.

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?

With 0% schema description coverage, the phrase 'by username' is the only explanatory text for the single parameter. It confirms the username string is the search key, but it adds no format details, exact-match expectation, or edge-case behavior.

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 ('Search'), a concrete resource ('GitHub user'), and the lookup key ('username'), so an agent can immediately tell what this tool does. It is distinct from sibling search tools like github_search_issues_prs and getters like github_get_user_activities.

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 intended use is implied: call this when looking up a GitHub user by username. However, the description gives no explicit when-to-use or when-not-to-use guidance and does not compare against any sibling tools, so an agent must infer the selection from context.

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