Skip to main content
Glama

get_api_key

Read-onlyIdempotent

Fetches metadata for a tenant API key by UUID without returning the secret value, letting you inspect key details.

Instructions

Retrieve metadata for a tenant API key. The secret key value is not returned.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "key_id": "<key_id>"
    },
    "name": "get_api_key"
  }
}

Input Schema

NameRequiredDescriptionDefault
key_idYesAPI key UUID

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv2.2.4
    • changedInput schema / properties / key_id / description
      Previous value: -"UUID da API Key"New value: +"API key UUID"
  2. First observedv0.1.0

TDQS

A3.7/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, and destructiveHint=false, so safety is covered structurally. The description adds genuinely useful behavioral context beyond that: the secret key value is deliberately withheld, which tells the agent what it will and will not receive for a sensitive resource. It stops short of describing error behavior for unknown or foreign-tenant keys.

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?

Two short sentences, zero filler, with the most decision-relevant constraint (no secret returned) front-loaded right after the purpose. Nothing is redundant.

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

Completeness3/5

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

With no output schema, the description bears responsibility for indicating return content, and 'metadata' is left undefined — no mention of which fields (name, created date, status, scopes) come back. It is adequate for a simple single-parameter read, but the return surface remains underspecified.

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?

Only one parameter with 100% schema description coverage ('API key UUID'), so the schema already carries the full semantics and a baseline of 3 applies. The description adds no meaning about the identifier itself, such as whether it accepts keys outside the caller's tenant.

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

Purpose4/5

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

States a specific verb ('Retrieve') and resource ('metadata for a tenant API key'), and the second sentence narrows the scope by excluding the secret value. An agent can distinguish this from create/update/delete/list operations on the same resource without opening a schema, though it does not name any sibling explicitly.

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

Usage Guidelines3/5

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

Usage is only implied by the single UUID parameter and the 'metadata' framing — an agent can infer this is the per-key lookup versus list_api_keys, but the description never states when to prefer it or any prerequisites (e.g., that the key must exist / be visible to the caller).

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

Deploy Server

Other Tools