Skip to main content
Glama
AutomoxCommunity

Automox MCP Server

Get User API Key

get_user_api_key
Read-onlyIdempotent

Retrieve metadata of a specific API key for a user by providing the user ID and key ID. The secret is never exposed.

Instructions

Get one user API key by user ID and key ID. Returns metadata only — the secret is never exposed.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
user_idYes
key_idYes
output_formatNojson

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Behavior4/5

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

Annotations already declare readOnlyHint=true and idempotentHint=true. The description adds the critical behavioral insight that the secret is never exposed and that only metadata is returned. This goes beyond the annotations and sets clear expectations about the tool's output limitations, though it does not cover error conditions or prerequisites.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single sentence that immediately communicates the tool's purpose and key constraint. It is front-loaded, concise, and contains no fluff.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool is simple (get by ID), has an output schema documenting return values, and annotations cover safety, the description is complete. It states what parameters are needed and the nature of the output (metadata only). No additional context is necessary.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The description explains two required parameters (user_id, key_id) but omits the optional output_format parameter. With 0% schema description coverage, the description should cover all parameters. It adds meaning for the required ones but leaves the third parameter undocumented, earning a baseline 3 with partial compensation.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states 'Get one user API key by user ID and key ID', specifying the verb, resource, and required parameters. It also distinguishes from sibling tools by noting that only metadata is returned and the secret is never exposed, which differentiates it from create, delete, update, and list variants.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies usage for viewing key metadata without exposing the secret. However, it does not explicitly state when to use this tool versus alternatives like list_user_api_keys or create_user_api_key. The phrase 'Returns metadata only' provides some guidance but lacks direct comparisons or exclusion criteria.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/AutomoxCommunity/automox-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server