github_get_user

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

With no annotations, the description carries the full burden for behavioral disclosure. It says 'Get' which implies read-only, but it doesn't explicitly state that there are no side effects, whether authentication is required beyond the session_name parameter, or what the response contains. The mention of 'authenticated user' hints at auth needs but doesn't fully disclose the behavior.

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 compact and front-loaded. The first sentence states the purpose, and the args are clearly listed in a structured format. No unnecessary words or repetition.

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 read tool with an output schema, the description covers the main purpose and both parameters. It lacks explicit statements about side effects or prerequisites, but the output schema handles return values. Overall, it is sufficiently complete for a low-complexity tool.

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?

Schema description coverage is 0%, so the description must compensate. It explains both parameters: username ('empty = authenticated user') and session_name ('GitHub session to use'), adding meaning beyond the schema's type/default definitions. This is helpful but session_name could be more detailed.

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 'Get user profile information' with a specific verb and resource. It also adds a distinctive behavior: 'authenticated user if username is empty', which distinguishes it from other get-type tools like github_get_org or github_get_repo.

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 provides clear context on when to use the tool: to fetch a user profile, with the special instruction for empty username meaning the authenticated user. It doesn't explicitly mention exclusions or alternatives, but the guidance is sufficient for typical use.

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