Skip to main content
Glama

Update custom column

well_update_custom_column
Destructive

Update an existing custom column in the current workspace.

Use this tool when the user asks to rename a column, change its rules, its formula, its format config, or its icon.

REQUIRED: custom_column_id OPTIONAL (only include fields the user wants changed): name, type (one of text, number, amount, date, boolean, single_select, multi_select, record_reference, ai), reference_target, reference_targets, is_multiple, position, icon, rules_config, formula_config, format_config

A change to record_reference also names the root the values point at: one root in reference_target, or two or more in reference_targets when a cell may name records of several roots (for example people and companies). Send one of the two, never both; no other type takes one. A column of people is a person column. is_multiple (record_reference only) is true when one cell holds a list of records. While a cell holds a value, a change that drops a root or switches between one record and a list is refused; those cells are cleared first.

CRITICAL SIDE EFFECT — recompute on config edit: Editing rules_config, formula_config, or format_config triggers an automatic recompute of EVERY row in this view (potentially expensive — proportional to the number of rows × the cost per AI call). Only edit these fields when the user explicitly asks to change column behavior. For pure cosmetic edits (rename, icon), pass only name or icon and leave the configs alone.

Returns { success: true, custom_column_id, name } on success, or { success: false, error } on failure.

Input Schema

NameRequiredDescriptionDefault
iconNoOptional Lucide icon name; pass null to clear
nameNoColumn header label
typeNoColumn data type
positionNoPosition within the view (0-indexed). Usually managed by drag-and-drop, not chat.
is_multipleNoFor a record_reference column only: true when one cell holds a list of records, false (the default) when it holds one
rules_configNoAI rules config; pass null to clear
workspace_idNoTarget workspace. Omit when the token authorizes one workspace. Required when it authorizes several — a write lands in exactly one workspace and this call would not say which.
format_configNoFormat config; pass null to clear
formula_configNoFormula config; pass null to clear
conversation_idNoThe conversation id returned by the previous Well result, in its meta under well/conversation_id, in its structuredContent, or in its JSON text block. Pass it back on every call in the same conversation, including a call a card makes, so the chosen workspace and the earlier answers still apply. It decides the conversation on its own: nothing the host states about the session replaces it. Omit it only on the first call of a conversation.
idempotency_keyNoOptional client-supplied key. A retried write with the same key returns the original result instead of re-applying the operation.
workspace_scopeNoRestrict this call to the family: the token's primary workspace plus the company workspaces under it that you are a member of. Unrelated authorized workspaces drop out of the read; row reads merge across the family, while a per-workspace figure still reports exactly one workspace.
custom_column_idYesThe UUID of the custom column to update (required)
reference_targetNoThe root a record_reference column points at, one of: account_balances, accounts, activities, companies, documents, employment_contracts, invoices, journal_entries, journals, ledger_accounts, notes, payment_means, payslips, people, products, projects, subscriptions, tasks, transactions. Required for type=record_reference, refused for every other type. A column targeting people is a person column
reference_targetsNoFor a record_reference column whose cells may name records of several roots (a polymorphic link, for example people and companies): every root, two or more. Use in place of reference_target, never with it

Output Schema

NameRequiredDescriptionDefault
codeNo
nameNo
errorNo
successYes
reply_linesNo
conversation_idNoThe conversation this result belongs to. Pass it back as the conversation_id argument on every later Well call in the same conversation.
near_candidatesNo
newly_connectedNoTools that connected to this workspace since the last result and that no session was told about yet, oldest first. Present only when at least one tool is new. The connected-line rule says when to tell an entry; when it does, one line per entry, in the person's language: "<name> is connected.". Never fold several entries into one sentence. Each entry comes back once, on one result only: never repeat its line later.
custom_column_idNo
conversation_id_noteNoPresent only when the server opened a fresh lane, stating that no choice recorded earlier was read.
conversation_id_sourceNoWhere the conversation id came from: the host's own request meta, the caller's argument, or a fresh lane the server opened.
near_candidates_truncatedNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • addedInput schema / properties / is_multiple
      Added value: +{
      +  "description": "For a record_reference column only: true when one cell holds a list of records, false (the default) when it holds one",
      +  "type": "boolean"
      +}
    • addedInput schema / properties / reference_targets
      Added value: +{
      +  "anyOf": [
      +    {
      +      "items": {
      +        "enum": [
      +          "account_balances",
      +          "accounts",
      +          "activities",
      +          "companies",
      +          "documents",
      +          "employment_contracts",
      +          "invoices",
      +          "journal_entries",
      +          "journals",
      +          "ledger_accounts",
      +          "notes",
      +          "payment_means",
      +          "payslips",
      +          "people",
      +          "products",
      +          "projects",
      +          "subscriptions",
      +          "tasks",
      +          "transactions"
      +        ],
      +        "type": "string"
      +      },
      +      "maxItems": 19,
      +      "minItems": 2,
      +      "type": "array"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "description": "For a record_reference column whose cells may name records of several roots (a polymorphic link, for example people and companies): every root, two or more. Use in place of reference_target, never with it"
      +}
  2. Changed2 schema fields changed
    • addedInput schema / properties / reference_target
      Added value: +{
      +  "anyOf": [
      +    {
      +      "enum": [
      +        "account_balances",
      +        "accounts",
      +        "activities",
      +        "companies",
      +        "documents",
      +        "employment_contracts",
      +        "invoices",
      +        "journal_entries",
      +        "journals",
      +        "ledger_accounts",
      +        "notes",
      +        "payment_means",
      +        "payslips",
      +        "people",
      +        "products",
      +        "projects",
      +        "subscriptions",
      +        "tasks",
      +        "transactions"
      +      ],
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "description": "The root a record_reference column points at, one of: account_balances, accounts, activities, companies, documents, employment_contracts, invoices, journal_entries, journals, ledger_accounts, notes, payment_means, payslips, people, products, projects, subscriptions, tasks, transactions. Required for type=record_reference, refused for every other type. A column targeting people is a person column"
      +}
    • changedInput schema / properties / type / enum
      Previous value: -[
      -  "text",
      -  "number",
      -  "amount",
      -  "single_select",
      -  "multi_select",
      -  "ai"
      -]New value: +[
      +  "text",
      +  "number",
      +  "amount",
      +  "date",
      +  "boolean",
      +  "single_select",
      +  "multi_select",
      +  "record_reference",
      +  "ai"
      +]
  3. Changed4 schema fields changed
    • addedOutput schema / properties / code
      Added value: +{
      +  "type": "string"
      +}
    • addedOutput schema / properties / near_candidates
      Added value: +{
      +  "items": {
      +    "additionalProperties": false,
      +    "properties": {
      +      "company_id": {
      +        "type": "string"
      +      },
      +      "name": {
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "company_id",
      +      "name"
      +    ],
      +    "type": "object"
      +  },
      +  "type": "array"
      +}
    • addedOutput schema / properties / near_candidates_truncated
      Added value: +{
      +  "type": "boolean"
      +}
    • addedOutput schema / properties / reply_lines
      Added value: +{
      +  "items": {
      +    "type": "string"
      +  },
      +  "type": "array"
      +}
  4. Added

TDQS

A4.3/5.0
Behavior5/5

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

Goes well beyond the destructiveHint=true annotation by naming the concrete cost: editing rules_config, formula_config, or format_config recomputes EVERY row in the view, scaling with row count times per-AI-call cost. It also discloses a refusal rule (a change that drops a root or switches between single and list on populated cells is refused) and the record_reference pairing constraint (reference_target xor reference_targets, never both).

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?

Front-loads purpose, then usage, then the CRITICAL SIDE EFFECT warning, and the warning earns its emphasis for a mutation that can trigger expensive recomputation. The one wasteful block is the re-listing of the full optional field set with the type enum values, which duplicates the schema verbatim and could be trimmed.

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

Completeness5/5

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

For a 15-parameter mutation tool it covers everything an agent needs: which id is required, that only changed fields should be sent, type-dependent constraints, destructive recompute cost, refusal behavior, and the success/failure return shape (with an output schema also present). Workspace and conversation plumbing are documented in the schema, so the description does not need to repeat them.

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 coverage is 100%, so the baseline is 3, but the description adds cross-field meaning: reference_target takes exactly one root while reference_targets takes two or more for polymorphic links, only one of the two may be sent, and neither applies to other types. It also separates REQUIRED from OPTIONAL fields and reiterates `is_multiple` semantics, adding modest value over the already-detailed schema descriptions.

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 an existing custom column in the current workspace") and scopes it to configuration fields (name, type, reference target, configs, icon), which distinguishes it from value-level edits. It does not name `well_update_custom_column_value` or `well_delete_custom_column`, so the boundary between editing a column's definition and editing a cell value is left for the agent to infer from the field list.

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 an explicit trigger list ("when the user asks to rename a column, change its rules, its formula, its format config, or its icon") and an explicit when-not: only touch rules/formula/format configs when the user asks to change behavior, and for cosmetic edits pass only `name` or `icon`. No alternative sibling tool is named as the right place to go for other column operations, which is the only missing piece for a 5.

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