Skip to main content
Glama

Set rental or dedicated number auto-renew

toggle_auto_renew
DestructiveIdempotent

Toggle auto-renewal for long-term rentals or dedicated numbers. When on, charges recur; if payment fails, renewal stops and the number expires.

Instructions

Turn auto-renewal on or off for a long-term rental (ren_...) or a dedicated number (ded_...). When on, each new period is charged to your balance at next_renewal_price_cents; if that charge fails, auto-renew switches off and the number expires at the end of its period. Ask the user before turning it on.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
rental_idYesren_... or ded_...
auto_renewYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
rentalNo
dedicated_numberNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv1.2.1
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "$schema": "http://json-schema.org/draft-07/schema#",
      +  "additionalProperties": {},
      +  "properties": {
      +    "dedicated_number": {
      +      "additionalProperties": {},
      +      "properties": {
      +        "auto_renew": {
      +          "type": "boolean"
      +        },
      +        "billing_period": {
      +          "type": "string"
      +        },
      +        "charged_price_cents": {
      +          "maximum": 9007199254740991,
      +          "minimum": -9007199254740991,
      +          "type": "integer"
      +        },
      +        "country": {
      +          "type": "string"
      +        },
      +        "country_name": {
      +          "type": "string"
      +        },
      +        "created_at": {
      +          "type": "string"
      +        },
      +        "display_id": {
      +          "type": [
      +            "string",
      +            "null"
      +          ]
      +        },
      +        "expires_at": {
      +          "type": "string"
      +        },
      +        "id": {
      +          "type": "string"
      +        },
      +        "messages": {
      +          "items": {
      +            "additionalProperties": {},
      +            "properties": {
      +              "code": {
      +                "type": [
      +                  "string",
      +                  "null"
      +                ]
      +              },
      +              "id": {
      +                "type": "string"
      +              },
      +              "received_at": {
      +                "type": "string"
      +              },
      +              "text": {
      +                "type": "string"
      +              }
      +            },
      +            "required": [
      +              "id",
      +              "text",
      +              "received_at"
      +            ],
      +            "type": "object"
      +          },
      +          "type": "array"
      +        },
      +        "next_renewal_price_cents": {
      +          "maximum": 9007199254740991,
      +          "minimum": -9007199254740991,
      +          "type": "integer"
      +        },
      +        "nickname": {
      +          "type": [
      +            "string",
      +            "null"
      +          ]
      +        },
      +        "paid_until": {
      +          "type": "string"
      +        },
      +        "phone_number": {
      +          "type": "string"
      +        },
      +        "quoted_price_cents": {
      +          "maximum": 9007199254740991,
      +          "minimum": -9007199254740991,
      +          "type": "integer"
      +        },
      +        "status": {
      +          "enum": [
      +            "active",
      +            "expired"
      +          ],
      +          "type": "string"
      +        }
      +      },
      +      "required": [
      +        "id",
      +        "status",
      +        "phone_number",
      +        "country",
      +        "country_name",
      +        "billing_period",
      +        "quoted_price_cents",
      +        "charged_price_cents",
      +        "next_renewal_price_cents",
      +        "auto_renew",
      +        "created_at",
      +        "paid_until",
      +        "expires_at"
      +      ],
      +      "type": "object"
      +    },
      +    "rental": {
      +      "additionalProperties": {},
      +      "properties": {
      +        "auto_renew": {
      +          "type": "boolean"
      +        },
      +        "can_cancel": {
      +          "type": "boolean"
      +        },
      +        "cancel_window_expires_at": {
      +          "type": [
      +            "string",
      +            "null"
      +          ]
      +        },
      +        "charged_price_cents": {
      +          "maximum": 9007199254740991,
      +          "minimum": -9007199254740991,
      +          "type": "integer"
      +        },
      +        "country": {
      +          "type": "string"
      +        },
      +        "created_at": {
      +          "type": "string"
      +        },
      +        "display_id": {
      +          "type": [
      +            "string",
      +            "null"
      +          ]
      +        },
      +        "duration": {
      +          "type": "string"
      +        },
      +        "expires_at": {
      +          "type": "string"
      +        },
      +        "id": {
      +          "type": "string"
      +        },
      +        "messages": {
      +          "items": {
      +            "additionalProperties": {},
      +            "properties": {
      +              "code": {
      +                "type": [
      +                  "string",
      +                  "null"
      +                ]
      +              },
      +              "id": {
      +                "type": "string"
      +              },
      +              "received_at": {
      +                "type": "string"
      +              },
      +              "text": {
      +                "type": "string"
      +              }
      +            },
      +            "required": [
      +              "id",
      +              "text",
      +              "received_at"
      +            ],
      +            "type": "object"
      +          },
      +          "type": "array"
      +        },
      +        "next_renewal_price_cents": {
      +          "maximum": 9007199254740991,
      +          "minimum": -9007199254740991,
      +          "type": "integer"
      +        },
      +        "paid_until": {
      +          "type": "string"
      +        },
      +        "phone_number": {
      +          "type": "string"
      +        },
      +        "re_rent_available": {
      +          "type": "boolean"
      +        },
      +        "re_rent_blocked_at": {
      +          "type": [
      +            "string",
      +            "null"
      +          ]
      +        },
      +        "re_rent_price_cents": {
      +          "anyOf": [
      +            {
      +              "maximum": 9007199254740991,
      +              "minimum": -9007199254740991,
      +              "type": "integer"
      +            },
      +            {
      +              "type": "null"
      +            }
      +          ]
      +        },
      +        "refunded_cents": {
      +          "maximum": 9007199254740991,
      +          "minimum": -9007199254740991,
      +          "type": "integer"
      +        },
      +        "rental_type": {
      +          "const": "rental",
      +          "type": "string"
      +        },
      +        "service_id": {
      +          "type": [
      +            "string",
      +            "null"
      +          ]
      +        },
      +        "service_name": {
      +          "type": "string"
      +        },
      +        "status": {
      +          "enum": [
      +            "active",
      +            "expired",
      +            "cancelled"
      +          ],
      +          "type": "string"
      +        }
      +      },
      +      "required": [
      +        "id",
      +        "status",
      +        "phone_number",
      +        "service_id",
      +        "service_name",
      +        "country",
      +        "duration",
      +        "rental_type",
      +        "charged_price_cents",
      +        "auto_renew",
      +        "next_renewal_price_cents",
      +        "re_rent_available",
      +        "re_rent_price_cents",
      +        "re_rent_blocked_at",
      +        "created_at",
      +        "paid_until",
      +        "expires_at",
      +        "can_cancel"
      +      ],
      +      "type": "object"
      +    }
      +  },
      +  "type": "object"
      +}
  2. Changed2 schema fields changedv1.1.8
    • changedInput schema / properties / rental_id / description
      Previous value: -"ren_xxx or ded_xxx"New value: +"ren_... or ded_..."
    • addedInput schema / properties / rental_id / pattern
      Added value: +"^(?:(?:ren|ded)_[A-Za-z0-9_-]{1,64})$"
  3. First observedv1.1.3

TDQS

A4.7/5.0
Behavior5/5

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

Annotations already flag destructiveHint=true, but the description adds the actual consequences: charging to balance at next_renewal_price_cents, and that a failed charge silently disables auto-renew and lets the number expire. That failure-mode disclosure is exactly the context an agent needs to warn a user before invoking it.

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 front-loaded sentences: purpose and scope first, consequence second, user-consent caveat last. No filler, and the most important routing information (what resource types it applies to) leads.

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 rich annotations and an output schema already present, the description only needs to cover mutation behavior and side effects — which it does fully, including the failure path. Nothing an agent needs to invoke this safely 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 only 50% (auto_renew has no schema description), so the description must compensate. It explains that ren_/ded_ prefixes identify the number type and gives real meaning to auto_renew=true as 'charged each period at next_renewal_price_cents', adding value beyond the bare boolean.

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 (turn on/off auto-renewal) and names the exact resource scope: long-term rentals (ren_...) and dedicated numbers (ded_...). This distinguishes it from the sibling set_proxy_auto_renew, which covers proxies, so an agent can route correctly without opening either schema.

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 operating condition — 'Ask the user before turning it on' — which tells the agent this mutation requires user consent. It does not explicitly name an alternative tool or a when-not-to-use case beyond that, so it falls short of full routing guidance.

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