Skip to main content
Glama

Update Profile Field

update_profile_field
Destructive

Modify a Circle community profile field's label, requirements, visibility, choices, or number formatting; set confirm=true only when the user requested this change.

Instructions

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

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
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.
payload_fileNoRegular local JSON body file, at most 5 MB. Cannot be mixed with body flags or payload.
profile_fieldNo
profile_field_idYesProfile field ID

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed8 schema fields changedv3.0.1
    • addedInput schema / $defs
      Added value: +{
      +  "profile_field": {
      +    "properties": {
      +      "allow_null": {
      +        "description": "Whether the field may be left empty",
      +        "type": "boolean"
      +      },
      +      "choices_attributes": {
      +        "description": "Option changes for a select or checkbox field. Omit id to add an option, send _destroy to remove one",
      +        "items": {
      +          "properties": {
      +            "_destroy": {
      +              "description": "Set to true to delete this choice and every member's selection of it",
      +              "type": "boolean"
      +            },
      +            "id": {
      +              "description": "Id of an existing choice. Omit to add a new one",
      +              "type": "integer"
      +            },
      +            "sort_key": {
      +              "description": "Position of the option, ascending",
      +              "type": "integer"
      +            },
      +            "value": {
      +              "description": "Option label",
      +              "type": "string"
      +            }
      +          },
      +          "type": "object"
      +        },
      +        "maxItems": 50,
      +        "type": "array"
      +      },
      +      "description": {
      +        "description": "Help text shown to members",
      +        "type": "string"
      +      },
      +      "key": {
      +        "description": "Unique identifier for the field within the community. Cannot be changed on a platform field",
      +        "maxLength": 100,
      +        "minLength": 1,
      +        "pattern": "^[a-z0-9_]+$",
      +        "type": "string"
      +      },
      +      "label": {
      +        "description": "Field label shown to members",
      +        "maxLength": 255,
      +        "minLength": 1,
      +        "type": "string"
      +      },
      +      "number_options_attributes": {
      +        "description": "Formatting changes for a number field",
      +        "properties": {
      +          "decimal": {
      +            "description": "Number of decimal places",
      +            "minimum": 0,
      +            "type": "integer"
      +          },
      +          "format": {
      +            "description": "How the number is formatted",
      +            "enum": [
      +              "number",
      +              "percentage",
      +              "custom",
      +              "unformatted"
      +            ],
      +            "type": "string"
      +          },
      +          "id": {
      +            "description": "Id of the number options belonging to this profile field",
      +            "type": "integer"
      +          },
      +          "position": {
      +            "description": "Which side of the number the custom text sits on",
      +            "enum": [
      +              "left",
      +              "right"
      +            ],
      +            "type": "string"
      +          },
      +          "text": {
      +            "description": "Custom text shown alongside the number. Required when format is custom",
      +            "type": "string"
      +          }
      +        },
      +        "type": "object"
      +      },
      +      "pages_attributes": {
      +        "description": "Visibility changes, addressed by page id",
      +        "items": {
      +          "properties": {
      +            "id": {
      +              "description": "Id of a page belonging to this profile field",
      +              "type": "integer"
      +            },
      +            "visible": {
      +              "description": "Whether the field is visible on this page",
      +              "type": "boolean"
      +            }
      +          },
      +          "required": [
      +            "id",
      +            "visible"
      +          ],
      +          "type": "object"
      +        },
      +        "type": "array"
      +      },
      +      "placeholder": {
      +        "description": "Placeholder text. Only meaningful for text, textarea and link fields",
      +        "type": "string"
      +      },
      +      "required": {
      +        "description": "Whether members must fill the field in",
      +        "type": "boolean"
      +      }
      +    },
      +    "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 / profile_field / $ref
      Added value: +"#/$defs/profile_field"
    • removedInput schema / properties / payload / properties / profile_field / properties
      Removed value: -{
      -  "allow_null": {
      -    "description": "Whether the field may be left empty",
      -    "type": "boolean"
      -  },
      -  "choices_attributes": {
      -    "description": "Option changes for a select or checkbox field. Omit id to add an option, send _destroy to remove one",
      -    "items": {
      -      "properties": {
      -        "_destroy": {
      -          "description": "Set to true to delete this choice and every member's selection of it",
      -          "type": "boolean"
      -        },
      -        "id": {
      -          "description": "Id of an existing choice. Omit to add a new one",
      -          "type": "integer"
      -        },
      -        "sort_key": {
      -          "description": "Position of the option, ascending",
      -          "type": "integer"
      -        },
      -        "value": {
      -          "description": "Option label",
      -          "type": "string"
      -        }
      -      },
      -      "type": "object"
      -    },
      -    "maxItems": 50,
      -    "type": "array"
      -  },
      -  "description": {
      -    "description": "Help text shown to members",
      -    "type": "string"
      -  },
      -  "key": {
      -    "description": "Unique identifier for the field within the community. Cannot be changed on a platform field",
      -    "maxLength": 100,
      -    "minLength": 1,
      -    "pattern": "^[a-z0-9_]+$",
      -    "type": "string"
      -  },
      -  "label": {
      -    "description": "Field label shown to members",
      -    "maxLength": 255,
      -    "minLength": 1,
      -    "type": "string"
      -  },
      -  "number_options_attributes": {
      -    "description": "Formatting changes for a number field",
      -    "properties": {
      -      "decimal": {
      -        "description": "Number of decimal places",
      -        "minimum": 0,
      -        "type": "integer"
      -      },
      -      "format": {
      -        "description": "How the number is formatted",
      -        "enum": [
      -          "number",
      -          "percentage",
      -          "custom",
      -          "unformatted"
      -        ],
      -        "type": "string"
      -      },
      -      "id": {
      -        "description": "Id of the number options belonging to this profile field",
      -        "type": "integer"
      -      },
      -      "position": {
      -        "description": "Which side of the number the custom text sits on",
      -        "enum": [
      -          "left",
      -          "right"
      -        ],
      -        "type": "string"
      -      },
      -      "text": {
      -        "description": "Custom text shown alongside the number. Required when format is custom",
      -        "type": "string"
      -      }
      -    },
      -    "type": "object"
      -  },
      -  "pages_attributes": {
      -    "description": "Visibility changes, addressed by page id",
      -    "items": {
      -      "properties": {
      -        "id": {
      -          "description": "Id of a page belonging to this profile field",
      -          "type": "integer"
      -        },
      -        "visible": {
      -          "description": "Whether the field is visible on this page",
      -          "type": "boolean"
      -        }
      -      },
      -      "required": [
      -        "id",
      -        "visible"
      -      ],
      -      "type": "object"
      -    },
      -    "type": "array"
      -  },
      -  "placeholder": {
      -    "description": "Placeholder text. Only meaningful for text, textarea and link fields",
      -    "type": "string"
      -  },
      -  "required": {
      -    "description": "Whether members must fill the field in",
      -    "type": "boolean"
      -  }
      -}
    • removedInput schema / properties / payload / properties / profile_field / type
      Removed value: -"object"
    • addedInput schema / properties / profile_field / $ref
      Added value: +"#/$defs/profile_field"
    • removedInput schema / properties / profile_field / properties
      Removed value: -{
      -  "allow_null": {
      -    "description": "Whether the field may be left empty",
      -    "type": "boolean"
      -  },
      -  "choices_attributes": {
      -    "description": "Option changes for a select or checkbox field. Omit id to add an option, send _destroy to remove one",
      -    "items": {
      -      "properties": {
      -        "_destroy": {
      -          "description": "Set to true to delete this choice and every member's selection of it",
      -          "type": "boolean"
      -        },
      -        "id": {
      -          "description": "Id of an existing choice. Omit to add a new one",
      -          "type": "integer"
      -        },
      -        "sort_key": {
      -          "description": "Position of the option, ascending",
      -          "type": "integer"
      -        },
      -        "value": {
      -          "description": "Option label",
      -          "type": "string"
      -        }
      -      },
      -      "type": "object"
      -    },
      -    "maxItems": 50,
      -    "type": "array"
      -  },
      -  "description": {
      -    "description": "Help text shown to members",
      -    "type": "string"
      -  },
      -  "key": {
      -    "description": "Unique identifier for the field within the community. Cannot be changed on a platform field",
      -    "maxLength": 100,
      -    "minLength": 1,
      -    "pattern": "^[a-z0-9_]+$",
      -    "type": "string"
      -  },
      -  "label": {
      -    "description": "Field label shown to members",
      -    "maxLength": 255,
      -    "minLength": 1,
      -    "type": "string"
      -  },
      -  "number_options_attributes": {
      -    "description": "Formatting changes for a number field",
      -    "properties": {
      -      "decimal": {
      -        "description": "Number of decimal places",
      -        "minimum": 0,
      -        "type": "integer"
      -      },
      -      "format": {
      -        "description": "How the number is formatted",
      -        "enum": [
      -          "number",
      -          "percentage",
      -          "custom",
      -          "unformatted"
      -        ],
      -        "type": "string"
      -      },
      -      "id": {
      -        "description": "Id of the number options belonging to this profile field",
      -        "type": "integer"
      -      },
      -      "position": {
      -        "description": "Which side of the number the custom text sits on",
      -        "enum": [
      -          "left",
      -          "right"
      -        ],
      -        "type": "string"
      -      },
      -      "text": {
      -        "description": "Custom text shown alongside the number. Required when format is custom",
      -        "type": "string"
      -      }
      -    },
      -    "type": "object"
      -  },
      -  "pages_attributes": {
      -    "description": "Visibility changes, addressed by page id",
      -    "items": {
      -      "properties": {
      -        "id": {
      -          "description": "Id of a page belonging to this profile field",
      -          "type": "integer"
      -        },
      -        "visible": {
      -          "description": "Whether the field is visible on this page",
      -          "type": "boolean"
      -        }
      -      },
      -      "required": [
      -        "id",
      -        "visible"
      -      ],
      -      "type": "object"
      -    },
      -    "type": "array"
      -  },
      -  "placeholder": {
      -    "description": "Placeholder text. Only meaningful for text, textarea and link fields",
      -    "type": "string"
      -  },
      -  "required": {
      -    "description": "Whether members must fill the field in",
      -    "type": "boolean"
      -  }
      -}
    • removedInput schema / properties / profile_field / type
      Removed value: -"object"
  2. First observedv2.0.0

TDQS

C2.4/5.0
Behavior3/5

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

Annotations already declare destructiveHint=true, idempotentHint=false, and openWorldHint=true, so the mutation profile is covered. The description adds that the operation 'changes community state' and requires confirm=true, which reinforces the destructive nature but adds little beyond the annotations and the schema's confirm description. It omits what is actually overwritten (e.g. that choice deletions via _destroy erase member selections).

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two short sentences with the constraint front-loaded, so there is no padding. However, the brevity comes at the cost of under-specification rather than through efficient information density, so it is merely adequate.

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?

This is a destructive, non-idempotent mutation with six parameters, deeply nested objects, and no output schema; the description should explain whether updates are partial or replace the whole field, what confirm guards, and what side effects reach members. None of that is present, leaving significant gaps for a complex tool.

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 83%, so the schema already documents nearly every parameter, including nested profile_field attributes. The description adds no parameter-level meaning (no partial-vs-full update semantics, no interaction between payload, payload_file, and body flags). Baseline 3 is appropriate when the schema does the heavy lifting.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose2/5

Does the description clearly state what the tool does and how it differs from similar tools?

The title sentence 'Update Profile Field' is a tautological restatement of the tool name; no verb+resource detail about what a profile field update actually changes. The second sentence describes a constraint ('Changes community state') rather than purpose, and does not distinguish it from siblings like create_profile_field, delete_profile_field, or archive_profile_field.

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?

No guidance on when to update vs archive/create/delete a profile field, nor on prerequisites such as permissions or which community the field belongs to. The only usage-ish content is the confirm flag requirement, which is a mechanical prerequisite rather than routing guidance.

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