Skip to main content
Glama

Hail Communication for AI

Update an agent

update_agent
Idempotent

Update selected fields on a saved workspace agent.

Omitted fields retain their values. Repeating the same update gives the same result. Changing only language or voice preserves the other value. A field cannot be both set and cleared in the same request. Removing a greeting makes an inbound agent wait for the caller. Other resets restore workspace defaults; the handover limit resets to 1800 seconds. Existing calls keep their starting settings; changes affect later calls and texts. Returns the updated agent or an error.

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": {
      "agent_id": "<agent_id>"
    },
    "name": "update_agent"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameNoAgent display name.
toolsNoNames of the tools the agent may use during a call or reply. Omitted: every tool the workspace's channels support. An empty list: none.
statusNo``paused`` stops the agent answering; ``live`` turns it back on.
agent_idYesSaved agent ID, from ``list_agents`` or ``create_agent``.
languageNoLanguage the agent speaks, as an ISO 639-1 code such as ``es``. Omitted: English.
voice_idNoText-to-speech voice ID from the voice provider that serves the call, such as an ElevenLabs voice ID. Omitted: the workspace's default voice.
llm_modelNoModel ID of the calling agent. Optional. Recorded for analytics only.
http_toolsNoUp to ten customer APIs the agent may call during calls, texts and email. Each entry: ``name`` (letters, digits, _), ``description`` (read by the model), ``url`` (public https), optional ``parameters`` (JSON Schema, type object), ``headers`` (static, stored encrypted, returned as names only), ``timeout_seconds`` (1 to 10, default 5) and ``wait_message`` (said on a call while waiting). The list replaces the saved one; an empty list removes it. On update, an entry without ``headers`` keeps the saved headers of the same name while the url keeps its host; a url on a new host needs ``headers`` again. The first save returns ``http_tool_secret`` once; requests carry ``X-Hail-Signature`` signed with it.
sms_enabledNoWhether this agent answers texts on numbers whose texts route to it.
clear_fieldsNoSettings to reset to the workspace default. Omitted: nothing is reset.
ai_disclosureNoSpeak the AI disclosure line first on every call.
email_enabledNoWhether this agent replies to mail on addresses routed to it.
first_messageNoGreeting spoken after the AI disclosure. Without one, an inbound agent waits for the caller.
system_promptNoInstructions that define the agent's behavior on calls, texts and email replies.
voice_enabledNoWhether this agent answers calls on numbers whose calls route to it.
handover_contactsNoReplaces the whole handover list; an empty list removes it. Up to ten ``{contact_id, note}`` entries, with ``contact_id`` from ``list_contacts``, ``lookup_contact`` or ``create_contact`` and a ``note`` of 1 to 200 characters.
recording_enabledNoRecording for this agent's calls. ``true`` or ``false`` overrides the workspace setting.
ai_disclosure_lineNoCustom AI disclosure line replacing the workspace line. ``{org}`` expands to the organization name.
max_duration_secondsNoLongest a call with this agent may last, in seconds, counted from pickup. At the limit the agent says goodbye and hangs up. Omitted: the workspace's call limit.
handover_max_duration_secondsNoLongest a call may last after a handover contact answers, in seconds, counted from that answer. Omitted: 1800 (30 minutes).

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / http_tools
      Added value: +{
      +  "anyOf": [
      +    {
      +      "items": {
      +        "additionalProperties": true,
      +        "type": "object"
      +      },
      +      "type": "array"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "Up to ten customer APIs the agent may call during calls, texts and email. Each entry: ``name`` (letters, digits, _), ``description`` (read by the model), ``url`` (public https), optional ``parameters`` (JSON Schema, type object), ``headers`` (static, stored encrypted, returned as names only), ``timeout_seconds`` (1 to 10, default 5) and ``wait_message`` (said on a call while waiting). The list replaces the saved one; an empty list removes it. On update, an entry without ``headers`` keeps the saved headers of the same name while the url keeps its host; a url on a new host needs ``headers`` again. The first save returns ``http_tool_secret`` once; requests carry ``X-Hail-Signature`` signed with it.",
      +  "title": "Http Tools"
      +}
  2. Changed1 schema field changed
    • addedInput schema / properties / llm_model
      Added value: +{
      +  "description": "Model ID of the calling agent. Optional. Recorded for analytics only.",
      +  "type": "string"
      +}
  3. Changed15 schema fields changed
    • changedInput schema / properties / clear_fields / anyOf
      Previous value: -[
      -  {
      -    "items": {
      -      "type": "string"
      -    },
      -    "type": "array"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]New value: +[
      +  {
      +    "items": {
      +      "enum": [
      +        "recording_enabled",
      +        "first_message",
      +        "ai_disclosure_line",
      +        "tools",
      +        "max_duration_seconds",
      +        "handover_max_duration_seconds"
      +      ],
      +      "type": "string"
      +    },
      +    "type": "array"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • changedInput schema / properties / clear_fields / description
      Previous value: -"Fields to reset: recording_enabled, first_message, ai_disclosure_line, tools, max_duration_seconds or handover_max_duration_seconds."New value: +"Settings to reset to the workspace default. Omitted: nothing is reset."
    • changedInput schema / properties / email_enabled / description
      Previous value: -"Answer email on addresses that route email to this agent."New value: +"Whether this agent replies to mail on addresses routed to it."
    • changedInput schema / properties / handover_max_duration_seconds / anyOf
      Previous value: -[
      -  {
      -    "type": "integer"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]New value: +[
      +  {
      +    "maximum": 3600,
      +    "minimum": 60,
      +    "type": "integer"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • changedInput schema / properties / handover_max_duration_seconds / description
      Previous value: -"Length limit in seconds for a call handed over to a person, 60 to 3600. The default is 1800."New value: +"Longest a call may last after a handover contact answers, in seconds, counted from that answer. Omitted: 1800 (30 minutes)."
    • changedInput schema / properties / language / anyOf
      Previous value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]New value: +[
      +  {
      +    "enum": [
      +      "ar",
      +      "bg",
      +      "bn",
      +      "cs",
      +      "da",
      +      "de",
      +      "el",
      +      "en",
      +      "es",
      +      "fi",
      +      "fr",
      +      "gu",
      +      "he",
      +      "hi",
      +      "hr",
      +      "hu",
      +      "id",
      +      "it",
      +      "ja",
      +      "kn",
      +      "ko",
      +      "mr",
      +      "ms",
      +      "nl",
      +      "no",
      +      "pl",
      +      "pt",
      +      "ro",
      +      "ru",
      +      "sk",
      +      "sv",
      +      "ta",
      +      "te",
      +      "th",
      +      "tl",
      +      "tr",
      +      "uk",
      +      "vi",
      +      "zh"
      +    ],
      +    "type": "string"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • changedInput schema / properties / language / description
      Previous value: -"Spoken language as a lowercase ISO 639-1 code, such as ``es``."New value: +"Language the agent speaks, as an ISO 639-1 code such as ``es``. Omitted: English."
    • changedInput schema / properties / max_duration_seconds / anyOf
      Previous value: -[
      -  {
      -    "type": "integer"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]New value: +[
      +  {
      +    "maximum": 3600,
      +    "minimum": 60,
      +    "type": "integer"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • changedInput schema / properties / max_duration_seconds / description
      Previous value: -"Call length limit in seconds, 60 to 3600."New value: +"Longest a call with this agent may last, in seconds, counted from pickup. At the limit the agent says goodbye and hangs up. Omitted: the workspace's call limit."
    • changedInput schema / properties / sms_enabled / description
      Previous value: -"Answer texts on numbers that route texts to this agent."New value: +"Whether this agent answers texts on numbers whose texts route to it."
    • changedInput schema / properties / status / anyOf
      Previous value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]New value: +[
      +  {
      +    "enum": [
      +      "live",
      +      "paused"
      +    ],
      +    "type": "string"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • changedInput schema / properties / status / description
      Previous value: -"``live`` or ``paused``; a paused agent does not answer."New value: +"``paused`` stops the agent answering; ``live`` turns it back on."
    • changedInput schema / properties / tools / description
      Previous value: -"Names of the tools the agent may use, checked against the server's tool registry. An empty list disables tools."New value: +"Names of the tools the agent may use during a call or reply. Omitted: every tool the workspace's channels support. An empty list: none."
    • changedInput schema / properties / voice_enabled / description
      Previous value: -"Answer calls on numbers that route calls to this agent."New value: +"Whether this agent answers calls on numbers whose calls route to it."
    • changedInput schema / properties / voice_id / description
      Previous value: -"Text-to-speech voice ID, applied by whichever voice provider serves the call."New value: +"Text-to-speech voice ID from the voice provider that serves the call, such as an ElevenLabs voice ID. Omitted: the workspace's default voice."
  4. First observed

TDQS

A4.3/5.0
Behavior5/5

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

Beyond the annotations, the description discloses important mutation semantics: omitted fields are preserved, repeated updates are idempotent, language and voice changes preserve each other, a field cannot be both set and cleared, resets restore workspace defaults, the handover limit resets to 1800 seconds, and changes affect only later calls and texts. It also states the return shape is the updated agent or an error.

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?

The description is front-loaded with the core purpose and organized into short, meaningful lines. Some lines duplicate details already present in the schema, such as the greeting behavior and handover default, but the overall size is appropriate for a 20-parameter mutation tool.

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 complex 20-parameter update tool with an output schema and safety annotations, the description covers the essential behavioral gaps an agent would otherwise miss: partial update semantics, reset behavior, idempotency, and the effect on existing versus future calls. Return values are covered by the output schema, so no further description is required there.

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 schema already documents each parameter. The description adds cross-field meaning that the schema does not fully express, such as the set-versus-clear conflict rule, language/voice preservation, and the 1800-second handover default.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific verb and resource: 'Update selected fields on a saved workspace agent.' The update verb naturally distinguishes it from create_agent, delete_agent, get_agent and list_agents, but the description does not explicitly contrast siblings or scope the tool against them.

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?

The description gives strong context for how to use the update operation: omitted fields retain values, partial updates are idempotent, and clear_fields is the reset mechanism. It does not explicitly state when to prefer update_agent over create_agent or delete_agent, but the usage context is clear enough for an agent.

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