Skip to main content
Glama

rename_delivery_key

Idempotent

Change a Delivery API key's label without altering its secret or access. Use this admin-only tool to update key names for clarity.

Instructions

Change a Delivery API key's label (Admin only). The secret and its access are unchanged. Returns {ok:true}.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesThe key's id from list_delivery_keys.
nameYesThe new label.
siteNoSite slug or id to act in (multisite). Omit to use this server's default site. Call list_sites to see what exists — an empty tree or search usually means the wrong site, not missing content.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv0.1.3
    • addedInput schema / properties / id / description
      Added value: +"The key's id from list_delivery_keys."
    • addedInput schema / properties / name / description
      Added value: +"The new label."
  2. First observedv0.1.0

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=false, idempotentHint=true and destructiveHint=false, so the safety profile is covered. The description adds real value beyond that: the admin authorization requirement, an explicit statement that the secret and access are unaffected (narrowing the blast radius precisely), and the {ok:true} return shape for a tool with no output schema.

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, zero filler, front-loaded with the action and the authorization constraint before the side-effect clarification and return value.

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 low-complexity, 3-parameter mutation with full annotation coverage, the description supplies everything an agent needs: what changes, the admin gate, what is explicitly not changed, and the return contract.

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 id, name and site are already documented in the schema, including the list_delivery_keys provenance hint for id. The description adds nothing about parameter format or semantics beyond that, so the baseline 3 applies.

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 — changing a Delivery API key's label — and immediately scopes it to the label so an agent knows this is not create/revoke. It is trivially distinguishable from siblings like create_delivery_key and revoke_delivery_key.

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 precondition ('Admin only') and, via the schema's reference to list_delivery_keys, the lookup path for the required id. It does not explicitly route against alternatives like revoke_delivery_key, but the intent is unambiguous from the purpose statement.

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