hail

Official

by hail-hq

Overview Schema Source Related Servers Discussions Admin

Python

Hybrid

Update an agent

update_agent

Idempotent

Change a saved agent. Safe to repeat: the same call gives the same result.

Instructions

Change a saved agent. Safe to repeat: the same call gives the same result.

    Only the fields you pass change; a field left out keeps its value.
    ``status`` is ``"live"`` or ``"paused"``; a paused agent does not
    answer. ``language`` is a lowercase ISO 639-1 code. Pass ``language``
    or ``voice_id`` alone: the other value is kept. ``max_duration_seconds``
    and ``handover_max_duration_seconds`` are 60..3600.
    ``handover_contacts`` replaces the whole list: ``[{contact_id, note}]``
    (max 10) as in ``create_agent``; ``[]`` removes every contact.

    To remove a value, list its name in ``clear_fields``. Allowed:
    ``first_message`` (the agent waits for the caller),
    ``ai_disclosure_line`` (back to the workspace line), ``tools``
    (back to all tools), ``max_duration_seconds`` (back to the workspace
    limit), ``handover_max_duration_seconds`` (back to 1800). Any other
    name is refused. Do not set and clear one field.

    Live calls keep the settings they started with. The change applies
    to the next call or text.

    Returns the updated ``AgentResponse`` as a dict, or
    ``{"error": "<message>"}``.

Input Schema

Name	Required	Description	Default
`name`	No
`tools`	No
`status`	No
`agent_id`	Yes
`language`	No
`voice_id`	No
`sms_enabled`	No
`clear_fields`	No
`ai_disclosure`	No
`first_message`	No
`system_prompt`	No
`voice_enabled`	No
`handover_contacts`	No
`recording_enabled`	No
`ai_disclosure_line`	No
`max_duration_seconds`	No
`handover_max_duration_seconds`	No

Output Schema

Name	Required	Description	Default
No arguments

Schema Changelog

Changes observed during successful MCP inspections.

First observedv0.29.0Oct 21, 2026

TDQS

A4.5/5.0

Behavior5/5

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

Beyond the annotations it discloses what actually matters operationally: live calls keep the settings they started with and the change applies to the next call or text, handover_contacts replaces the entire list, and clear_fields reverts specific values to workspace defaults rather than blanking them. It also states the return shape (AgentResponse dict or an error dict), which the annotations do not cover.

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?

Purpose and idempotency are front-loaded, then field-level constraints, then clear_fields, then the live-call caveat and return value — a sensible progression with no filler sentences. It is dense for a 17-parameter tool, but the density is justified by real constraints rather than padding.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a non-destructive mutation tool with 0% schema coverage and 17 parameters, the description covers the failure-prone paths (clear/set conflicts, list replacement, duration bounds, live-call timing) and even the error return shape despite an output schema existing. The gap is the mundane field semantics it skips, which are largely inferable from names but not stated.

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 description coverage is 0% across 17 parameters, so the description carries the burden and does so for the tricky ones: status enum values, lowercase ISO 639-1 for language, the language/voice_id mutual exclusion, the 60..3600 range on both duration fields, and the [{contact_id, note}] shape with a max of 10 for handover_contacts. Several booleans (sms_enabled, voice_enabled, recording_enabled, ai_disclosure), plus name and system_prompt, are left entirely to the schema titles, which keeps it from a 5.

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?

The opening sentence names a specific verb and resource — "Change a saved agent" — which separates it cleanly from create_agent, get_agent, delete_agent and list_agents without ambiguity. The immediately following clause also establishes the partial-update semantics, so an agent knows the operation mode as well as the target.

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?

It gives concrete operating rules: only passed fields change, do not set and clear the same field, pass language or voice_id alone, and clear_fields accepts only the listed names with everything else refused. It never explicitly routes the agent to create_agent or delete_agent for adjacent tasks, so it stops short of the explicit when-not/alternative guidance a 5 requires.

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