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.

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": {
      "organizationId": "<organizationId>",
      "keyId": "<keyId>",
      "name": "<name>"
    },
    "name": "RenameApiKey"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameYes
keyIdYes
organizationIdYes

Output Schema

NameRequiredDescriptionDefault
dataNo
errorsNo
extensionsNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedOutput schema / properties / data / properties / organization / anyOf
      Previous value: -[
      -  {
      -    "properties": {
      -      "renameKey": {
      -        "description": "Updates the name of an ApiKey",
      -        "properties": {
      -          "id": {
      -            "description": "The API key's ID.",
      -            "oneOf": [
      -              {
      -                "type": "string"
      -              },
      -              {
      -                "type": "integer"
      -              }
      -            ]
      -          },
      -          "keyName": {
      -            "anyOf": [
      -              {
      -                "type": "string"
      -              },
      -              {
      -                "type": "null"
      -              }
      -            ],
      -            "description": "The API key's name, for distinguishing it from other keys."
      -          }
      -        },
      -        "required": [
      -          "id"
      -        ],
      -        "type": "object"
      -      }
      -    },
      -    "required": [
      -      "renameKey"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]New value: +[
      +  {
      +    "properties": {
      +      "renameKey": {
      +        "description": "Updates the name of an ApiKey. name must not exceed 250 characters.",
      +        "properties": {
      +          "id": {
      +            "description": "The API key's ID.",
      +            "oneOf": [
      +              {
      +                "type": "string"
      +              },
      +              {
      +                "type": "integer"
      +              }
      +            ]
      +          },
      +          "keyName": {
      +            "anyOf": [
      +              {
      +                "type": "string"
      +              },
      +              {
      +                "type": "null"
      +              }
      +            ],
      +            "description": "The API key's name, for distinguishing it from other keys."
      +          }
      +        },
      +        "required": [
      +          "id"
      +        ],
      +        "type": "object"
      +      }
      +    },
      +    "required": [
      +      "renameKey"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
  2. Added

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already mark this as non-read-only, destructive, idempotent, and open-world. The description adds useful behavioral context by clarifying that the key value and its access do not change, effectively scoping the destructive mutation to the name only, and it notes the return values.

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 sentences, front-loaded with the operation, then impact, return value, and required inputs. Every sentence earns its place and there is no filler.

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?

For a three-parameter mutation with an output schema and full annotations, the description covers purpose, input sourcing, mutation scope, and return values. Nothing essential is missing for correct invocation.

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 description coverage is 0%, so the description has to carry parameter meaning. It does so for all three parameters: organization ID, key ID (with source from GetApiKeys), and the new name, though it does not give format details.

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 states a specific verb and resource — renaming an API key in an organization — and anchors it to an equivalent CLI command. It also clarifies that key value and access are unchanged, so the agent can distinguish this mutation from CreateApiKey or DeleteApiKey.

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?

It gives clear context: use this to rename, and supply the organization ID plus the key ID that GetApiKeys returns. It does not explicitly list when not to use it versus CreateApiKey or DeleteApiKey, so it falls short of full alternative routing.

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