Skip to main content
Glama

Update a domain API key

update_domain_api_key
Destructive

Modify an existing domain API key's name, active status, or expiry date in place. Preview changes first, then confirm to apply—the key value itself stays unchanged.

Instructions

Updates a domain API key's name, active state, and/or expiry in place — never changes the key value itself (use rotate_domain_api_key for that). Only the fields you pass are changed. Requires confirm=true — first call WITHOUT confirm to preview the exact changes, then again with confirm:true.

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": {
      "domainId": "<domainId>",
      "keyId": "<keyId>"
    },
    "name": "update_domain_api_key"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameNo
keyIdYesThe key's id — from list_domain_api_keys.
confirmNoMust be true to apply. Omit/false returns a preview only.
domainIdYesThe domain's id — from list_domains.
isActiveNoDeactivate (false) or reactivate (true) the key without deleting it.
expiresAtNoISO 8601 expiry.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.53.0

TDQS

A4.9/5.0
Behavior5/5

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

Goes well beyond the single destructiveHint annotation by disclosing partial-update semantics ('only the fields you pass are changed'), the immutability of the key secret, and a mandatory preview-then-apply confirmation gate. This tells the agent the operation is scoped and reversible-until-confirmed rather than a broad destructive write, which is exactly the context the annotation alone cannot convey.

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 tight sentences, each doing distinct work: scope, the excluded sibling, partial-update rule, and the confirm workflow. No filler and the critical constraint (key value unchanged) is front-loaded.

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 six-parameter mutation tool with high schema coverage and no output schema, the description covers everything an agent needs: mutability scope, partial-update behavior, the required confirm sequence, and the sibling to use for key rotation. No meaningful gap remains.

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 83%, so the baseline is 3, and the description raises it by adding meaning the schema does not: that omitted fields are untouched (partial PATCH semantics) and that confirm drives a preview/apply state machine. It does not add format constraints for expiresAt or name beyond what the schema already documents.

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 ('Updates a domain API key'), enumerates exactly which fields are mutable (name, active state, expiry), and explicitly excludes the key value, pointing to rotate_domain_api_key for that. An agent can separate this from rotate/create/delete siblings without opening a schema.

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

Usage Guidelines5/5

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

Gives both when-to-use and when-not-to-use ('never changes the key value itself — use rotate_domain_api_key for that'), plus the required two-call sequence: preview without confirm, then re-call with confirm:true. No alternative is left to inference.

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