Skip to main content
Glama

Update a community segment

update_community_segment
Destructive

Modify an existing Circle community segment by updating its title, visibility, or filter rules. Requires confirm=true because it changes community state.

Instructions

Update a community segment. Changes community state and requires confirm=true for the user-requested action.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
rulesNo
titleNo
accountNoNamed private Circle account; selects credentials, not a remote community ID.
confirmNoSet true only when the user asked for exactly this action.
payloadNoComplete JSON request body instead of body flags. Supports nested Tiptap, maps and nullable values.
visibleNo
segment_idYesID of the community segment to update
payload_fileNoRegular local JSON body file, at most 5 MB. Cannot be mixed with body flags or payload.
community_segment_consumer_attributesNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed10 schema fields changedv3.0.1
    • addedInput schema / $defs
      Added value: +{
      +  "rules": {
      +    "properties": {
      +      "rule_type": {
      +        "enum": [
      +          "all_contacts",
      +          "all_members",
      +          "custom_filters",
      +          "selected_members"
      +        ],
      +        "type": "string"
      +      },
      +      "rules": {
      +        "anyOf": [
      +          {
      +            "items": {
      +              "properties": {
      +                "filter_type": {
      +                  "enum": [
      +                    "is",
      +                    "is_not",
      +                    "contains",
      +                    "does_not_contain",
      +                    "gt",
      +                    "lt",
      +                    "eq"
      +                  ],
      +                  "type": "string"
      +                },
      +                "id": {
      +                  "type": "string"
      +                },
      +                "key": {
      +                  "type": "string"
      +                },
      +                "value": {
      +                  "type": [
      +                    "string",
      +                    "boolean"
      +                  ]
      +                }
      +              },
      +              "required": [
      +                "key",
      +                "value"
      +              ],
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          {
      +            "items": {
      +              "properties": {
      +                "community_member_id": {
      +                  "type": "integer"
      +                },
      +                "email": {
      +                  "format": "email",
      +                  "type": "string"
      +                }
      +              },
      +              "required": [
      +                "email",
      +                "community_member_id"
      +              ],
      +              "type": "object"
      +            },
      +            "type": "array"
      +          }
      +        ]
      +      }
      +    },
      +    "required": [
      +      "rule_type",
      +      "rules"
      +    ],
      +    "type": "object"
      +  }
      +}
    • changedInput schema / properties / confirm / description
      Previous value: -"Must be true for the specific user-requested write."New value: +"Set true only when the user asked for exactly this action."
    • addedInput schema / properties / payload / properties / rules / $ref
      Added value: +"#/$defs/rules"
    • removedInput schema / properties / payload / properties / rules / properties
      Removed value: -{
      -  "rule_type": {
      -    "enum": [
      -      "all_contacts",
      -      "all_members",
      -      "custom_filters",
      -      "selected_members"
      -    ],
      -    "type": "string"
      -  },
      -  "rules": {
      -    "anyOf": [
      -      {
      -        "items": {
      -          "properties": {
      -            "filter_type": {
      -              "enum": [
      -                "is",
      -                "is_not",
      -                "contains",
      -                "does_not_contain",
      -                "gt",
      -                "lt",
      -                "eq"
      -              ],
      -              "type": "string"
      -            },
      -            "id": {
      -              "type": "string"
      -            },
      -            "key": {
      -              "type": "string"
      -            },
      -            "value": {
      -              "type": [
      -                "string",
      -                "boolean"
      -              ]
      -            }
      -          },
      -          "required": [
      -            "key",
      -            "value"
      -          ],
      -          "type": "object"
      -        },
      -        "type": "array"
      -      },
      -      {
      -        "items": {
      -          "properties": {
      -            "community_member_id": {
      -              "type": "integer"
      -            },
      -            "email": {
      -              "format": "email",
      -              "type": "string"
      -            }
      -          },
      -          "required": [
      -            "email",
      -            "community_member_id"
      -          ],
      -          "type": "object"
      -        },
      -        "type": "array"
      -      }
      -    ]
      -  }
      -}
    • removedInput schema / properties / payload / properties / rules / required
      Removed value: -[
      -  "rule_type",
      -  "rules"
      -]
    • removedInput schema / properties / payload / properties / rules / type
      Removed value: -"object"
    • addedInput schema / properties / rules / $ref
      Added value: +"#/$defs/rules"
    • removedInput schema / properties / rules / properties
      Removed value: -{
      -  "rule_type": {
      -    "enum": [
      -      "all_contacts",
      -      "all_members",
      -      "custom_filters",
      -      "selected_members"
      -    ],
      -    "type": "string"
      -  },
      -  "rules": {
      -    "anyOf": [
      -      {
      -        "items": {
      -          "properties": {
      -            "filter_type": {
      -              "enum": [
      -                "is",
      -                "is_not",
      -                "contains",
      -                "does_not_contain",
      -                "gt",
      -                "lt",
      -                "eq"
      -              ],
      -              "type": "string"
      -            },
      -            "id": {
      -              "type": "string"
      -            },
      -            "key": {
      -              "type": "string"
      -            },
      -            "value": {
      -              "type": [
      -                "string",
      -                "boolean"
      -              ]
      -            }
      -          },
      -          "required": [
      -            "key",
      -            "value"
      -          ],
      -          "type": "object"
      -        },
      -        "type": "array"
      -      },
      -      {
      -        "items": {
      -          "properties": {
      -            "community_member_id": {
      -              "type": "integer"
      -            },
      -            "email": {
      -              "format": "email",
      -              "type": "string"
      -            }
      -          },
      -          "required": [
      -            "email",
      -            "community_member_id"
      -          ],
      -          "type": "object"
      -        },
      -        "type": "array"
      -      }
      -    ]
      -  }
      -}
    • removedInput schema / properties / rules / required
      Removed value: -[
      -  "rule_type",
      -  "rules"
      -]
    • removedInput schema / properties / rules / type
      Removed value: -"object"
  2. First observedv2.0.0

TDQS

C2.9/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=false, destructiveHint=true, idempotentHint=false, and openWorldHint=true, so the safety profile is covered. The description adds the confirm=true requirement, a genuinely useful behavioral gate, but says nothing about reversibility, credential selection via the account param, or side effects on members.

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?

Two short sentences, front-loaded with the action and then the confirm gate; no filler. Brevity is appropriate, though it borders on under-specification for a 9-parameter mutation.

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

Completeness2/5

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

For a destructive, non-idempotent mutation with 9 parameters, nested objects, and no output schema, the description is too thin. It omits the payload/payload_file/body-flag alternatives and any indication of what 'changes community state' actually affects.

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

Parameters2/5

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

Schema description coverage is only 56% across 9 parameters, and the description compensates for none of it beyond restating confirm. It does not clarify the payload vs. payload_file vs. body-flag mutual exclusion, nor the rules/rule_type structure.

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?

States a specific verb and resource ('Update a community segment'), which distinguishes it from create/delete/duplicate siblings by name. However, it adds no scope detail (e.g. what a segment is or what parts are updated) beyond the title.

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

Usage Guidelines2/5

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

The description notes confirm=true is required 'for the user-requested action', which hints at a gating condition, but it never says when to choose this tool over siblings like create_community_segment or delete_community_segment, nor what prerequisites exist.

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

Deploy Server

Other Tools