Get User API Key

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

Beyond the annotations (readOnlyHint=true, destructiveHint=false, idempotentHint=true), the description adds critical context: 'Returns metadata only — the secret is never exposed.' This informs the agent about the tool's safety and output limitations, which annotations alone do not convey.

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 a single, clear sentence with an additional clarifying statement. It is concise, front-loaded, and contains no extraneous information.

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 get tool with no output schema, the description adequately states what the tool does and its key behavioral trait (metadata-only). However, it could specify what metadata includes or mention error handling (e.g., 'if found'), but the provided context is generally sufficient given the straightforward nature of the 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?

With 0% schema description coverage, the description must compensate. It explicitly mentions 'by user ID and key ID', mapping to the two required parameters. However, it omits the optional 'output_format' parameter, leaving its purpose unexplained.

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 action ('Get one user API key'), the resource ('user API key'), and the identification method ('by user ID and key ID'). It also distinguishes from siblings like 'list_user_api_keys' by specifying 'one' and from creation/deletion tools by its verb. The additional note about returning metadata only adds specificity.

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 usage for retrieving a specific API key metadata but does not explicitly state when to use this over alternatives like 'list_user_api_keys' or 'get_user'. No guidance on prerequisites or when not to use it is provided.

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