Skip to main content
Glama

Update Segment Group

update_segment_group

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
modeNo'single' or 'multi'; omit to leave unchanged.
nameNoNew name; omit to leave unchanged.
criteriaNoThe classify scope to track — {agent_ids, senders}, the campaign (agent_tasks) ids and teammate emails, each null = all. A provided object REPLACES the whole stored scope (an axis you leave out becomes all), so pass the current value of any axis you keep; omit the object to leave it unchanged. New people in this scope are tagged automatically and classify reuses it, so change it to re-target what the segment tracks.
group_idYesThe segment group to edit (from list_segment_groups).
descriptionNoNew one-line description; omit to leave unchanged.
on_behalf_ofNoAn agency client's email, from list_agency_clients, to run this call in that client's account: their agents, settings, connected accounts, and credits. Omit it to act on your own account.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • changedInput schema / properties / mode / anyOf
      Previous value: -[
      -  {
      -    "enum": [
      -      "single",
      -      "multi"
      -    ],
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]New value: +[
      +  {
      +    "enum": [
      +      "single",
      +      "multi"
      +    ],
      +    "title": "Mode",
      +    "type": "string"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • addedInput schema / properties / on_behalf_of
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "An agency client's email, from list_agency_clients, to run this call in that client's account: their agents, settings, connected accounts, and credits. Omit it to act on your own account."
      +}
  2. Changed1 schema field changed
    • changedInput schema / properties / criteria / description
      Previous value: -"The classify scope to track — {agent_ids, senders}, the campaign (agent_tasks)\nids and teammate emails, each null = all. A provided object REPLACES the whole stored\nscope (an axis you leave out becomes all), so pass the current value of any axis you\nkeep; omit the object to leave it unchanged. classify reuses this scope, so change it\nto re-target what the segment tracks."New value: +"The classify scope to track — {agent_ids, senders}, the campaign (agent_tasks)\nids and teammate emails, each null = all. A provided object REPLACES the whole stored\nscope (an axis you leave out becomes all), so pass the current value of any axis you\nkeep; omit the object to leave it unchanged. New people in this scope are tagged\nautomatically and classify reuses it, so change it to re-target what the segment\ntracks."
  3. Changed1 schema field changed
    • changedInput schema / properties / criteria / anyOf
      Previous value: -[
      -  {
      -    "description": "The persisted classify scope a segment tracks — campaigns and teammates (a person has no\nintrinsic channel, so channel is a view filter, never a classify criterion). Each axis null =\nall (every campaign / every teammate). Omit the whole object to leave criteria unset (create)\nor unchanged (edit).",
      -    "properties": {
      -      "agent_ids": {
      -        "anyOf": [
      -          {
      -            "items": {
      -              "type": "integer"
      -            },
      -            "type": "array"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ],
      -        "default": null
      -      },
      -      "senders": {
      -        "anyOf": [
      -          {
      -            "items": {
      -              "type": "string"
      -            },
      -            "type": "array"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ],
      -        "default": null
      -      }
      -    },
      -    "title": "CriteriaInput",
      -    "type": "object"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]New value: +[
      +  {
      +    "description": "The persisted classify scope a segment tracks — campaigns and teammates (a person has no\nintrinsic channel, so channel is a view filter, never a classify criterion). Each axis null =\nall (every campaign / every teammate). Omit the whole object to leave criteria unset (create)\nor unchanged (edit).",
      +    "properties": {
      +      "agent_ids": {
      +        "anyOf": [
      +          {
      +            "items": {
      +              "type": "integer"
      +            },
      +            "type": "array"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ],
      +        "default": null
      +      },
      +      "senders": {
      +        "anyOf": [
      +          {
      +            "items": {
      +              "type": "string"
      +            },
      +            "type": "array"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ],
      +        "default": null
      +      }
      +    },
      +    "title": "Criteria",
      +    "type": "object"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
  4. Changed2 schema fields changed
    • changedInput schema / properties / criteria / anyOf
      Previous value: -[
      -  {
      -    "description": "The persisted classify scope a segment tracks — campaigns only (a person has no intrinsic\nchannel, so channel is a view filter, never a classify criterion). `agent_ids` null = every\ncampaign. Omit the whole object to leave criteria unset (create) or unchanged (edit).",
      -    "properties": {
      -      "agent_ids": {
      -        "anyOf": [
      -          {
      -            "items": {
      -              "type": "integer"
      -            },
      -            "type": "array"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ],
      -        "default": null
      -      }
      -    },
      -    "title": "CriteriaInput",
      -    "type": "object"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]New value: +[
      +  {
      +    "description": "The persisted classify scope a segment tracks — campaigns and teammates (a person has no\nintrinsic channel, so channel is a view filter, never a classify criterion). Each axis null =\nall (every campaign / every teammate). Omit the whole object to leave criteria unset (create)\nor unchanged (edit).",
      +    "properties": {
      +      "agent_ids": {
      +        "anyOf": [
      +          {
      +            "items": {
      +              "type": "integer"
      +            },
      +            "type": "array"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ],
      +        "default": null
      +      },
      +      "senders": {
      +        "anyOf": [
      +          {
      +            "items": {
      +              "type": "string"
      +            },
      +            "type": "array"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ],
      +        "default": null
      +      }
      +    },
      +    "title": "CriteriaInput",
      +    "type": "object"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • changedInput schema / properties / criteria / description
      Previous value: -"The classify scope to track — {agent_ids}, the campaign (agent_tasks) ids (null =\nevery campaign). A provided object REPLACES the stored scope; omit to leave it unchanged.\nclassify reuses this scope, so change it to re-target what the segment tracks."New value: +"The classify scope to track — {agent_ids, senders}, the campaign (agent_tasks)\nids and teammate emails, each null = all. A provided object REPLACES the whole stored\nscope (an axis you leave out becomes all), so pass the current value of any axis you\nkeep; omit the object to leave it unchanged. classify reuses this scope, so change it\nto re-target what the segment tracks."
  5. Changed1 schema field changed
    • addedInput schema / properties / criteria
      Added value: +{
      +  "anyOf": [
      +    {
      +      "description": "The persisted classify scope a segment tracks — campaigns only (a person has no intrinsic\nchannel, so channel is a view filter, never a classify criterion). `agent_ids` null = every\ncampaign. Omit the whole object to leave criteria unset (create) or unchanged (edit).",
      +      "properties": {
      +        "agent_ids": {
      +          "anyOf": [
      +            {
      +              "items": {
      +                "type": "integer"
      +              },
      +              "type": "array"
      +            },
      +            {
      +              "type": "null"
      +            }
      +          ],
      +          "default": null
      +        }
      +      },
      +      "title": "CriteriaInput",
      +      "type": "object"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "The classify scope to track — {agent_ids}, the campaign (agent_tasks) ids (null =\nevery campaign). A provided object REPLACES the stored scope; omit to leave it unchanged.\nclassify reuses this scope, so change it to re-target what the segment tracks."
      +}
  6. Added

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=false and destructiveHint=false, so the mutation/safety profile is covered. The description adds genuinely useful behavior beyond that: partial-update semantics ('only the fields you pass change') and the non-obvious fact that editing does not trigger re-classification. It stops short of stating auth/permission requirements or whether an omitted axis reverting to 'all' can silently widen scope (that detail lives in the schema).

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?

Organized into summary and returns blocks, with the core behavior front-loaded in the first sentence. The returns block enumerates the response dict fields, which is verbose but earns its place since no output schema exists. No filler sentences.

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 mutation tool with no output schema, the description usefully supplies the return shape (id, name, description, mode, updated_at, criteria, tags) and the classify follow-up workflow, which is the main non-obvious behavior. Remaining gaps — permission requirements and the multi-step consequence of overwriting criteria — are minor given the fully documented schema and clear annotations.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so each parameter (mode, name, criteria, group_id, description, on_behalf_of) is already documented in the schema, including the replace semantics for criteria. The description's 'only the fields you pass change' and 'change its description, mode, or classify scope' largely restate what the schema says, so baseline 3 is appropriate.

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 and resource ('Rename a segment group or change its description, mode, or classify scope') and enumerates exactly which fields are editable. It also names the downstream sibling classify_segment_group, so an agent can tell it apart from creation and classification tools.

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?

Gives clear operational context: 'Only the fields you pass change' and 'Editing does not re-classify anything — follow with classify_segment_group(force=True) to re-tag.' That is a real when-and-what-next statement routing to an alternative. It does not, however, distinguish itself from near-neighbors like update_segment_tag or state when an edit is preferred over delete+recreate.

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