Skip to main content
Glama

update_sip_credential

Idempotent

Change a SIP credential's label, caller reference or internal extension without disturbing the device using it — no password change and no dropped registration. Changing the caller reference is pushed to the registrar, so it takes effect on the next outbound call; clearing it makes calls present the number itself. The extension is resolved by Sautikit rather than the registrar, so changing it applies immediately and needs no change on the device; clearing it removes the device from internal dialling. Fails with numbers.extension_taken when another credential already uses that extension.

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": {
      "number_id": "<number_id>",
      "credential_id": "<credential_id>"
    },
    "name": "update_sip_credential"
  }
}

Input Schema

NameRequiredDescriptionDefault
labelNonew human label for the device; omit to leave unchanged
purposeNoRequired on tools that read data or reports; recommended on every tool. One sentence: what you are doing and why (for example "finding this caller's open ticket to answer them"). Building a report, dashboard, analytics or an export is a SautiDesk Pro feature done by the report tools, not by pulling records.
client_idNonew caller reference substituted for the caller number on outbound calls; omit to leave unchanged, or pass an empty string to clear it (calls then present the number itself)
extensionNonew internal extension (exactly 4 digits, unique across the workspace); omit to leave unchanged. Applies immediately and needs no change on the device.
number_idYestenant number UUID
credential_idYesSIP credential UUID (from list_sip_credentials)
clear_client_idNoset true to clear the caller reference so outbound calls present the number itself
clear_extensionNoset true to clear the extension, removing this device from internal dialling

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.6/5.0
Behavior5/5

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

Goes well past the annotations (idempotent, non-destructive, closed-world) by disclosing propagation behavior: caller-reference changes are pushed to the registrar and only take effect on the next outbound call, while extension changes are resolved by Sautikit and apply immediately. It also discloses clearing side effects and a concrete failure mode (numbers.extension_taken).

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 core action and its non-disruption guarantee, and each subsequent sentence carries distinct operational information. There is mild repetition between the opening 'without disturbing the device' and the later 'needs no change on the device', and the density makes it slightly heavy for a five-sentence block.

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 an 8-parameter mutation tool with no output schema, the definition covers the mutability envelope, per-field propagation behavior, clearing semantics, and the key error code. No return-format explanation is needed since no output schema exists, and nothing an agent needs to invoke it 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 100%, so the baseline is 3, but the description adds effect timing and consequences the schema does not: clearing the caller reference makes calls present the number itself, and clearing the extension removes the device from internal dialling. The label, purpose, and UUID parameters are left entirely to the schema, which is acceptable given full coverage.

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 (change) and resource (SIP credential) plus the exact mutable fields (label, caller reference, internal extension), and immediately bounds scope with 'no password change and no dropped registration'. This sharply separates it from rotate_sip_credential, revoke_sip_credential and reveal_sip_credential 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 Guidelines4/5

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

Clear context for when to use it: non-disruptive metadata/identity edits while a device stays registered, with explicit exclusion of password rotation. It does not name the alternative tool for password changes, leaving the agent to infer rotate_sip_credential from the domain, so it falls short of full when/when-not/alternatives routing.

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