Skip to main content
Glama

Rename API Key

rename_api_key
Idempotent

Rename an ActivitySmith API key. The key secret and its access do not change. Requires the "Manage API keys" permission, which the user grants on the ActivitySmith approval screen.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameYesNew descriptive name, such as "GitHub Actions deploy".
public_idYesAPI key public_id from list_api_keys.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
messageYes
successYes
public_idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already declare non-destructive, idempotent, closed-world behavior, so the bar is lower. The description usefully adds that the secret and access are preserved and that an approval-screen permission is required, which annotations cannot express; it stops short of richer detail like failure modes or rename conflicts.

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?

Three short sentences, front-loaded with the action, followed by scope and prerequisite. No filler or repetition of the schema.

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?

An output schema exists, annotations cover the safety profile, and the schema fully documents both params. The description supplies the two things structured fields cannot: the permission prerequisite and the guarantee that the secret/access are untouched. Nothing needed to call this correctly is missing.

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 coverage is 100% and both parameters carry their own descriptions (including the example name and the pointer to list_api_keys for public_id), so the schema does the heavy lifting. The description adds no parameter-level meaning beyond that, making the baseline 3 correct.

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?

States a specific verb and resource ("Rename an ActivitySmith API key") and immediately bounds the effect ("The key secret and its access do not change"), which separates it from the create/delete/list API key siblings in the same family.

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 clear usage context: it names the required "Manage API keys" permission and what is unaffected by the operation, so the agent knows this is a metadata-only rename. It does not, however, explicitly contrast with list_api_keys or delete_api_key, and there is no update_api_key sibling to route away from.

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