Skip to main content
Glama

Update DID renewal (billing cycles) / description / detach E911

update_did
Destructive

Manage a DID's renewal by setting billing_cycles_count. Three modes: null = the DID AUTO-RENEWS every billing cycle (monthly) indefinitely; N (a positive integer) = the DID renews for N MORE cycles (a countdown), then stops; 0 = STOP renewing: the DID keeps no renewal count and stays valid until the end of its current expiration date, then expires (this is the SOFT, reversible alternative to deleting a DID — set it back to null or N to resume renewing). Omit billing_cycles_count to leave it unchanged. Can also set or clear the DID description (to label several DIDs at once, use update_did_description). Can also DETACH the DID from its Emergency Calling Service (E911): pass emergency_calling_service_id: null (requires the emergency management permission, like the panel). Only unassignment is supported — assignment goes through the emergency domain verification flow. E911 is billed per number, so removing the number stops its charge from the next renewal; a service left with NO numbers is auto-canceled within a few hours (the customer is notified) — no extra cancellation step is needed. Returns the DID number, its resulting expiration date (expires_at), the new billing_cycles_count and the description.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
did_idYesUUID of the DID to update (must belong to the customer).
descriptionNoFree text, e.g. an internal ticket reference. null or "" clears it. Omit to leave unchanged.
billing_cycles_countNoRenewal control. null = auto-renew indefinitely; a positive integer N = renew for N more cycles then stop; 0 = stop renewing (DID stays valid until its expiration date, then expires — the soft alternative to deleting). Omit to leave unchanged.
emergency_calling_service_idNoONLY null is accepted: detaches the DID from its Emergency Calling Service (E911). Errors if the DID is not assigned to one. Billing is per number — the detached number stops being charged; a service left with no numbers auto-cancels within a few hours. Omit to leave the E911 assignment unchanged.

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?

Annotations declare destructiveHint=true and readOnlyHint=false, but the description adds substantial context: unlike a hard delete, mode 0 is reversible and the DID remains valid until expiration; detaching E911 stops per-number billing from the next renewal; a service left with no numbers auto-cancels within hours with customer notification. It also names the required permission (emergency management).

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?

Front-loaded with the primary renewal mechanism before the secondary description and E911 behaviors. It is long and overlaps with the schema's own field descriptions, but every clause carries operational meaning (reversibility, billing, auto-cancel), so waste is minimal.

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 supplies the return payload (DID number, expires_at, new billing_cycles_count, description), documents all four parameters' edge cases, and covers permissions and side effects — everything needed to invoke correctly.

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. The description still adds value by synthesizing billing_cycles_count into three behavioral modes (including the countdown interpretation) and by clarifying omit-to-leave-unchanged and only-null-accepted for E911, plus the null/"" clear semantics for 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 (update) and resource (DID) and enumerates the three distinct operations it manages: renewal via billing_cycles_count, description, and E911 detach. It also explicitly names the sibling to use for bulk description updates (update_did_description), so an agent can tell it apart from adjacent tools.

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 mode semantics (null = auto-renew indefinitely, N = N more cycles, 0 = stop renewing) and frames 0 as the soft reversible alternative to delete_did. It also states that E911 assignment is not supported here and must go through the emergency domain verification flow, routing the agent away from this tool for that case.

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