Skip to main content
Glama

Restore terminated DID

restore_did
Destructive

Restore one of the authenticated customer's TERMINATED DIDs by id, bringing the number back into service (find terminated numbers with list_dids terminated: true). Only works while the number is still in the terminated state — roughly 35 days after termination it is released to public stock and can no longer be restored (it will not be found). Restoring a still-valid DID is free. But if the DID has already EXPIRED, restoring first RENEWS it and CHARGES the renewal price (USD, like every DIDWW amount) to the account balance — a PAID operation. This paid case is confirmation-gated — warn the user it is a paid renew before confirming. With insufficient balance the restore fails and nothing changes. On success the DID is unblocked and set to auto-renew (billing_cycles_count null); use update_did afterwards to change that. Returns the restored DID with its new expiration date.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
did_idYesUUID of the terminated DID to restore (from list_dids with terminated: true).
confirmation_tokenNoOnly needed when the DID has EXPIRED (restoring it is then a PAID renew). Leave empty on the first call — it returns a preview + confirmation_token and charges nothing; re-call with the token to renew and restore.

Schema Changelog

Changes observed during successful MCP inspections.

No schema history has been recorded yet.

TDQS

A4.8/5.0
Behavior5/5

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

Goes well beyond the annotations (destructiveHint=true, readOnlyHint=false, idempotentHint=false): discloses pricing semantics (free for still-valid, charged renew for expired), the ~35-day window, insufficient-balance failure behavior, and success post-conditions (unblocked, set to auto-renew, billing_cycles_count null). This is rich operational context the agent cannot derive from structured fields.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Information is front-loaded (purpose, then window, then pricing, then gating, then post-conditions) and nearly every sentence carries distinct operational facts. Slightly dense with capitalized emphasis, but no wasted sentences.

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?

With no output schema, the description compensates by stating the return value ('restored DID with its new expiration date'), the cost implications, and failure modes. Nothing an agent needs 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.

Parameters4/5

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

Schema coverage is 100%, so the baseline is 3, but the description adds real value on confirmation_token: it explains the two-call preview-then-confirm flow and that the first call charges nothing. That explains the intent of the parameter beyond the schema's field description.

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+resource — restore a TERMINATED DID by id — and scopes it to the authenticated customer. An agent can distinguish it from siblings like list_dids, get_did, buy_did, and update_did without opening any 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 explicit routing ('find terminated numbers with list_dids terminated: true'), an eligibility window (~35 days before release to public stock), and the confirmation-gated paid case ('warn the user it is a paid renew before confirming'). It names the alternative for discovery and the follow-up tool (update_did) to change auto-renew.

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