Skip to main content
Glama

RenameApiKey

DestructiveIdempotent

Rename an API key in an organization, the same write that rover api-key rename performs. The key value and its access do not change. Returns the key's ID and new name. Provide the organization ID, the key ID, which GetApiKeys returns, and the new name.

Input Schema

NameRequiredDescriptionDefault
nameYes
keyIdYes
organizationIdYes

Output Schema

NameRequiredDescriptionDefault
dataNo
errorsNo
extensionsNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already declare the write profile (readOnlyHint=false, destructiveHint=true, idempotentHint=true), so the bar is lower. The description still adds genuinely useful context that 'the key value and its access do not change,' telling the agent the rename is name-only and does not rotate the secret or alter permissions. It does not state permission requirements, but the safety profile is well covered.

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?

Four short lines, front-loaded with the action, then the non-effect clarification, the return shape, and the inputs. Every sentence contributes and none restates the schema verbatim without adding meaning.

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

Completeness4/5

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

An output schema exists, yet the description still briefly notes the return value (key ID and new name), and annotations cover the write semantics, so the agent has enough to call it correctly. Minor gaps remain on auth scope and whether key IDs can be reused after a rename.

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

Parameters4/5

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

Schema coverage is 0%, so the description must carry parameter meaning, and it does: organizationId, keyId, and name are all identified, with keyId explicitly sourced from GetApiKeys. It stops short of format hints (e.g. whether name has length or character constraints), leaving a small gap.

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 and resource ('Rename an API key in an organization') and anchors it to the equivalent CLI write, so it is immediately distinguishable from CreateApiKey, DeleteApiKey, and GetApiKeys. It references GetApiKeys as the source of the key ID, giving partial sibling linkage, but never explicitly contrasts its scope against the other key-management tools.

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?

Gives a clear prerequisite chain: organization ID, key ID (from GetApiKeys), and new name, plus the CLI equivalent for context on when this write is appropriate. No explicit 'when not to use' clause is offered, which keeps it short of a 5.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources