whoami

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so the safety profile is covered. The description adds value beyond that by disclosing what information the call surfaces (identity, server URL, access level, enabled tools), which is exactly the behavioral context an agent needs for a diagnostic call. It stops short of explaining failure behavior when the PAT is invalid or the server is unreachable.

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 with the purpose front-loaded and the returned fields listed after a colon. Every clause earns its place and there is no redundant restatement of the tool name.

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?

With no output schema, the description carries the burden of describing return values, and it does so by naming the four pieces of information returned. It is essentially complete for a zero-argument diagnostic tool; only error/unauthorized behavior is left unstated.

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 takes zero parameters, so there is nothing for the description to disambiguate; the baseline for a no-parameter tool applies. Nothing in the text implies hidden or optional inputs.

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 opens with a concrete verb ('Check the connection') and then enumerates exactly what is returned: the signed-in user (owner of the PAT), server URL, extension access level, and enabled tools. No sibling tool in the list performs identity or connection diagnostics, so an agent can distinguish it from list_* / get_* tools immediately.

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 framing as a connection/diagnostic check makes the intended use clear: verify auth, endpoint, and feature availability before or instead of other calls. It does not state explicit exclusions or say when not to call it, but no sibling provides an overlapping capability, so no alternative needs to be named.

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