Skip to main content
Glama

update_api_key

Modify an existing API key's name, description, permissions, usage limits, or alert settings to manage access and control.

Instructions

Update an existing API key's name, description, scopes, or limits

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesThe UUID of the API key to update
nameNoNew display name for the key
descriptionNoNew description for the key
scopesNoNew permission scopes for the key
credit_limitNoNew credit limit for usage
alert_thresholdNoNew alert threshold percentage (0-100)
rate_limit_rpmNoNew rate limit in requests per minute
default_config_idNoNew default configuration ID
default_metadataNoNew default metadata key-value pairs
alert_emailsNoNew email addresses for alerts
Behavior2/5

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

No annotations are provided, so the description carries full burden. It states this is an update operation, implying mutation, but doesn't disclose behavioral traits like whether it requires specific permissions, if changes are reversible, what happens to unspecified fields (partial vs. full updates), rate limits, or error conditions. For a mutation tool with zero annotation coverage, this is a significant gap.

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, efficient sentence that front-loads the core purpose. Every word earns its place: 'Update' (action), 'an existing API key' (resource), and the list of modifiable attributes. There is no wasted text or redundancy.

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

Completeness2/5

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

Given the tool's complexity (10 parameters, mutation operation, no output schema, and no annotations), the description is incomplete. It doesn't explain the update behavior (e.g., partial vs. full, idempotency), required permissions, response format, or error handling. For a mutation tool with rich parameters but no structured safety hints, the description should provide more contextual guidance.

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?

Schema description coverage is 100%, so the schema already documents all 10 parameters thoroughly. The description lists the updatable fields ('name, description, scopes, or limits'), which aligns with some parameters but doesn't add meaning beyond what the schema provides (e.g., 'limits' vaguely maps to 'credit_limit', 'rate_limit_rpm', etc.). Baseline 3 is appropriate when schema does the heavy lifting.

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?

The description clearly states the action ('Update') and resource ('an existing API key') with specific attributes that can be modified ('name, description, scopes, or limits'). It distinguishes from sibling 'create_api_key' by specifying 'existing API key' and from 'delete_api_key' by being an update rather than deletion. However, it doesn't explicitly differentiate from other update tools like 'update_user' or 'update_workspace' beyond the resource type.

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

Usage Guidelines2/5

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

The description provides no guidance on when to use this tool versus alternatives. It doesn't mention prerequisites (e.g., needing admin permissions), when not to use it (e.g., for creating new keys), or how it compares to similar tools like 'update_virtual_key' or 'update_user'. The agent must infer usage from the tool name and description alone.

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/s-b-e-n-s-o-n/portkey-admin-mcp'

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