Skip to main content
Glama

Update an agent's settings

update_agent
DestructiveIdempotent

Update an agent's settings

Changes the settings you send: the name, the description, the Main Instructions (instructions), the time zone, the AI handoff and comment auto-hide. Send at least one (422 no_settings otherwise). Everything is validated before anything changes. instructions replaces the whole text, and the AI follows the new text on its next replies, usually within a minute; sending the text the agent already has changes nothing. A key can't change an agent's status (so it can't delete one), ai_model, model_provider, avatar_url or language: sending any of them with a value is 422 field_not_writable, with the field in param, and nothing changes. Deleting an agent stays in the dashboard; follow-ups have updateFollowUpSettings, and the AI's switch per channel updateConnection.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameNoCan't be blank or contain angle brackets. Stored without surrounding spaces.
agent_idYesThe agent the resource belongs to. Another company's agent, or the nil UUID, is `404 agent_not_found`; an agent outside the key's agent list is `403 agent_not_authorized`.
time_zoneNoAn IANA time zone in Region/City form, such as `Africa/Cairo` (`422 unknown_timezone` otherwise), or an empty string for the platform default.
descriptionNoAn empty string clears it. Can't contain angle brackets. Stored without surrounding spaces.
instructionsNoThe Main Instructions. Replaces the whole text, stored and given to the AI exactly as sent; can't be blank. Send plain text with a blank line between rules: the dashboard shows lines without one as a single paragraph, and saves them that way when someone edits them there.
ai_handoff_enabledNoWhether a reply from your team pauses the AI in that conversation.
ai_handoff_window_minutesNoHow long the AI stays paused after your team's last message. Kept while the handoff is off.
comment_auto_hide_enabledNoWhether the AI hides negative Facebook and Instagram comments on the agent's pages.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.8/5.0
Behavior5/5

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

Annotations only supply destructive/idempotent/openWorld hints; the description goes well beyond them by disclosing atomic validation ('Everything is validated before anything changes'), the full-replacement semantics of `instructions`, the propagation delay ('the AI follows the new text on its next replies, usually within a minute'), the no-op behavior when the text is unchanged, and the `422 field_not_writable` contract with the offending field in `param`. That is the behavioral detail a mutation tool needs.

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 correctly: field list first, then validation/replacement behavior, then rejection rules, then sibling routing. Individual sentences are clause-heavy and slightly run-on, but every clause carries operational information and there is no filler.

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, no-output-schema mutation tool, the description supplies the missing pieces: error codes, atomicity, replacement semantics, propagation latency, and escape hatches to sibling tools. Nothing an agent needs to invoke this correctly is absent, and return formats are unnecessary given the absence of an output schema.

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 and the per-field mechanics (IANA format, clearing via empty string, length bounds) are already handled by the schema. The description earns the bump by explaining whole-text replacement for `instructions`, the no-op re-send case, and the fact that certain fields are rejected wholesale — semantics the schema's `additionalProperties: false` does not itself convey.

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?

Specific verb+resource (update an agent's settings) followed immediately by an exhaustive enumeration of the mutable surface: name, description, instructions, time zone, AI handoff, comment auto-hide. It also explicitly carves out what is *not* this tool — deletion lives in the dashboard, follow-ups in `updateFollowUpSettings`, per-channel AI switch in `updateConnection` — so the agent can separate it from every nearby sibling.

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?

States the precondition plainly ('Send at least one (`422 no_settings` otherwise)') and names the replacement tools for the adjacent concerns, which is exactly the when/when-not/alternative guidance an agent needs. The non-writable field list ('status', 'ai_model', 'model_provider', 'avatar_url', 'language') doubles as a do-not-attempt directive with the resulting error code.

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