Skip to main content
Glama

Update inbox

update_inbox
Destructive

Make changes to an inbox: name, greeting, auto-assignment, CSAT survey (on/off, csat_config: emoji or star display and an optional survey message), single-conversation lock, business hours flag, timezone or out-of-office message. Only the fields you pass change, but csat_config replaces the whole object, so repeat the current message when changing only the display type. null clears the greeting, out-of-office message or csat_config.

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": {
      "inbox_id": "<inbox_id>"
    },
    "name": "update_inbox"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameNo
inbox_idYes
timezoneNo
csat_configNo
greeting_enabledNo
greeting_messageNo
csat_survey_enabledNo
out_of_office_messageNo
working_hours_enabledNo
enable_auto_assignmentNo
lock_to_single_conversationNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / csat_config
      Added value: +{
      +  "additionalProperties": false,
      +  "properties": {
      +    "display_type": {
      +      "enum": [
      +        "emoji",
      +        "star"
      +      ],
      +      "type": "string"
      +    },
      +    "message": {
      +      "maxLength": 500,
      +      "type": "string"
      +    }
      +  },
      +  "type": [
      +    "object",
      +    "null"
      +  ]
      +}
  2. First observed

TDQS

A3.8/5.0
Behavior4/5

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

The description adds behavior that the annotations cannot express: partial-update semantics, the fact that csat_config is a replace-the-whole-object field rather than a merge, and that null explicitly clears the greeting, out-of-office message, or csat_config. That last point is important given destructiveHint=true, since it discloses a data-clearing path. It does not mention permissions, whether changes propagate to live conversations, or reversibility, so it stops short of a 5.

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?

Three dense sentences, front-loaded with the mutable field list, followed by the two rules an agent most needs (partial update, csat_config replacement) and the null-clearing note. Nearly every clause earns its place; only the long comma-separated enumeration in sentence one is slightly heavy to parse.

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 an 11-parameter destructive mutation with no output schema, the description covers the critical pitfalls: patch semantics, the csat_config replacement trap, and null clearing. What an agent still cannot determine is permission requirements, uniqueness constraints on name, and the effect on in-flight conversations, which keeps it below 5.

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 11 parameters, so the description has to carry the load, and it does for the hardest cases: it spells out csat_config's two fields (emoji/star display and optional survey message) and the null semantics of greeting_message, out_of_office_message, and csat_config. It leaves inbox_id, timezone format, and the interaction between working_hours_enabled and the separate working-hours tool unexplained.

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+resource ('Make changes to an inbox') and enumerates the mutable surface: name, greeting, auto-assignment, CSAT survey, single-conversation lock, business hours flag, timezone, out-of-office. That separates it from read-side siblings like get_inbox/list_inboxes and from update_agents_in_inbox. It does not draw the boundary against the sibling update_working_hours, even though 'business hours flag' sits close to it, so it falls short of full sibling differentiation.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

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

There is no explicit when-to-use/when-not statement, no prerequisite or permission guidance, and no naming of alternatives. Usage is only implied through the field list and the patch-semantics rule 'Only the fields you pass change', which tells an agent how to call it but not when to prefer it.

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