Skip to main content
Glama

Create Profile Field

create_profile_field
Destructive

Create a custom member profile field for a Circle community, setting its label, type, required status, and page visibility. Requires confirm=true because it changes community state.

Instructions

Create 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

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed10 schema fields changedv3.0.1
    • addedInput schema / $defs
      Added value: +{
      +  "profile_field": {
      +    "properties": {
      +      "allow_null": {
      +        "description": "Whether the field may be left empty. Defaults to false",
      +        "type": "boolean"
      +      },
      +      "choices_attributes": {
      +        "description": "Options for a select or checkbox field. Required for those types, must be absent otherwise",
      +        "items": {
      +          "properties": {
      +            "sort_key": {
      +              "description": "Position of the option, ascending",
      +              "type": "integer"
      +            },
      +            "value": {
      +              "description": "Option label",
      +              "type": "string"
      +            }
      +          },
      +          "required": [
      +            "value"
      +          ],
      +          "type": "object"
      +        },
      +        "maxItems": 50,
      +        "type": "array"
      +      },
      +      "description": {
      +        "description": "Help text shown to members",
      +        "type": "string"
      +      },
      +      "field_type": {
      +        "description": "Type of field to create",
      +        "enum": [
      +          "text",
      +          "select",
      +          "checkbox",
      +          "textarea",
      +          "link",
      +          "number"
      +        ],
      +        "type": "string"
      +      },
      +      "key": {
      +        "description": "Unique identifier for the field within the community. Lowercase letters, numbers and underscores only",
      +        "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 for a number field. Required for that type, must be absent otherwise",
      +        "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"
      +          },
      +          "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"
      +          }
      +        },
      +        "required": [
      +          "format"
      +        ],
      +        "type": "object"
      +      },
      +      "pages_attributes": {
      +        "description": "The pages the field appears on. Send all four to state visibility explicitly",
      +        "items": {
      +          "properties": {
      +            "name": {
      +              "description": "Page the field appears on",
      +              "enum": [
      +                "signup",
      +                "edit_profile",
      +                "profile_view",
      +                "community_view"
      +              ],
      +              "type": "string"
      +            },
      +            "visible": {
      +              "description": "Whether the field is visible on this page",
      +              "type": "boolean"
      +            }
      +          },
      +          "required": [
      +            "name",
      +            "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. Defaults to false",
      +        "type": "boolean"
      +      }
      +    },
      +    "required": [
      +      "label",
      +      "field_type",
      +      "key",
      +      "pages_attributes"
      +    ],
      +    "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. Defaults to false",
      -    "type": "boolean"
      -  },
      -  "choices_attributes": {
      -    "description": "Options for a select or checkbox field. Required for those types, must be absent otherwise",
      -    "items": {
      -      "properties": {
      -        "sort_key": {
      -          "description": "Position of the option, ascending",
      -          "type": "integer"
      -        },
      -        "value": {
      -          "description": "Option label",
      -          "type": "string"
      -        }
      -      },
      -      "required": [
      -        "value"
      -      ],
      -      "type": "object"
      -    },
      -    "maxItems": 50,
      -    "type": "array"
      -  },
      -  "description": {
      -    "description": "Help text shown to members",
      -    "type": "string"
      -  },
      -  "field_type": {
      -    "description": "Type of field to create",
      -    "enum": [
      -      "text",
      -      "select",
      -      "checkbox",
      -      "textarea",
      -      "link",
      -      "number"
      -    ],
      -    "type": "string"
      -  },
      -  "key": {
      -    "description": "Unique identifier for the field within the community. Lowercase letters, numbers and underscores only",
      -    "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 for a number field. Required for that type, must be absent otherwise",
      -    "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"
      -      },
      -      "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"
      -      }
      -    },
      -    "required": [
      -      "format"
      -    ],
      -    "type": "object"
      -  },
      -  "pages_attributes": {
      -    "description": "The pages the field appears on. Send all four to state visibility explicitly",
      -    "items": {
      -      "properties": {
      -        "name": {
      -          "description": "Page the field appears on",
      -          "enum": [
      -            "signup",
      -            "edit_profile",
      -            "profile_view",
      -            "community_view"
      -          ],
      -          "type": "string"
      -        },
      -        "visible": {
      -          "description": "Whether the field is visible on this page",
      -          "type": "boolean"
      -        }
      -      },
      -      "required": [
      -        "name",
      -        "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. Defaults to false",
      -    "type": "boolean"
      -  }
      -}
    • removedInput schema / properties / payload / properties / profile_field / required
      Removed value: -[
      -  "label",
      -  "field_type",
      -  "key",
      -  "pages_attributes"
      -]
    • 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. Defaults to false",
      -    "type": "boolean"
      -  },
      -  "choices_attributes": {
      -    "description": "Options for a select or checkbox field. Required for those types, must be absent otherwise",
      -    "items": {
      -      "properties": {
      -        "sort_key": {
      -          "description": "Position of the option, ascending",
      -          "type": "integer"
      -        },
      -        "value": {
      -          "description": "Option label",
      -          "type": "string"
      -        }
      -      },
      -      "required": [
      -        "value"
      -      ],
      -      "type": "object"
      -    },
      -    "maxItems": 50,
      -    "type": "array"
      -  },
      -  "description": {
      -    "description": "Help text shown to members",
      -    "type": "string"
      -  },
      -  "field_type": {
      -    "description": "Type of field to create",
      -    "enum": [
      -      "text",
      -      "select",
      -      "checkbox",
      -      "textarea",
      -      "link",
      -      "number"
      -    ],
      -    "type": "string"
      -  },
      -  "key": {
      -    "description": "Unique identifier for the field within the community. Lowercase letters, numbers and underscores only",
      -    "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 for a number field. Required for that type, must be absent otherwise",
      -    "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"
      -      },
      -      "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"
      -      }
      -    },
      -    "required": [
      -      "format"
      -    ],
      -    "type": "object"
      -  },
      -  "pages_attributes": {
      -    "description": "The pages the field appears on. Send all four to state visibility explicitly",
      -    "items": {
      -      "properties": {
      -        "name": {
      -          "description": "Page the field appears on",
      -          "enum": [
      -            "signup",
      -            "edit_profile",
      -            "profile_view",
      -            "community_view"
      -          ],
      -          "type": "string"
      -        },
      -        "visible": {
      -          "description": "Whether the field is visible on this page",
      -          "type": "boolean"
      -        }
      -      },
      -      "required": [
      -        "name",
      -        "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. Defaults to false",
      -    "type": "boolean"
      -  }
      -}
    • removedInput schema / properties / profile_field / required
      Removed value: -[
      -  "label",
      -  "field_type",
      -  "key",
      -  "pages_attributes"
      -]
    • removedInput schema / properties / profile_field / type
      Removed value: -"object"
  2. First observedv2.0.0

TDQS

C2.6/5.0
Behavior3/5

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

Annotations already declare destructiveHint=true, readOnlyHint=false, openWorldHint=true, and idempotentHint=false, so the safety profile is largely covered. The description reinforces the state-changing/destructive nature and mentions the confirm gate, but the confirm requirement is also documented in the schema's confirm parameter description, so it adds limited new context. No mention of return behavior, side effects on members, or rate limits.

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?

Only two short sentences and reasonably front-loaded, but the first sentence is pure tautology and the second largely duplicates what the confirm parameter schema already states. It is brief without being wasteful, yet barely earns its space.

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

Completeness3/5

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

For a tool with a deep nested schema (5 params, nested objects) and no output schema, the description is thin but the schema compensates with rich field-level descriptions. It omits a top-level illustration of the payload shape and the conditional requirements for choices/number options, which would help, but nothing critical to invocation is missing.

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 80%, so the schema already carries the parameter burden (including nested profile_field, choices_attributes, and number_options_attributes semantics). The description adds nothing about parameters, so the baseline 3 is appropriate.

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?

"Create Profile Field" merely restates the tool name and title; the only added content is "Changes community state," which is a generic behavior shared by all mutating siblings. Nothing distinguishes it from update_profile_field, delete_profile_field, or archive_profile_field. This is essentially tautological rather than a specific verb+resource+scope statement.

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 a confirm=true requirement but gives no when-to-use context and no differentiation from sibling profile-field tools (update/delete/archive). An agent gets no guidance on choosing this tool over its closest relatives or on prerequisites beyond the confirm flag.

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