Skip to main content
Glama

twprojects-update_custom_field

Modify an existing custom field's settings, such as display name, unit, formula, options, and required status.

Instructions

Update custom field.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesThe ID of the custom field to update.
nameNoThe display name of the custom field.
unitNoThe unit associated with the custom field, when applicable.
formulaNoThe formula expression for 'formula' type custom fields.
optionsNoType-specific options for the custom field. For 'dropdown' and 'multiselect' types, provide {"choices": [{"value": "...", "color": "#rrggbb"}, ...]}. For 'rating' type, provide {"icon": "star|heart|...", "color": "#rrggbb"}. For 'number-decimal' type, provide {"decimals": <int>}.
requiredNoWhether the custom field must have a value when set on an entity.
descriptionNoAn optional description for the custom field.
currency_codeNoThe ISO currency code for 'currency' or 'financial' type custom fields.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed14 schema fields changedv1.39.3
    • removedInput schema / properties / currency_code / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedInput schema / properties / currency_code / type
      Added value: +"string"
    • removedInput schema / properties / description / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedInput schema / properties / description / type
      Added value: +"string"
    • removedInput schema / properties / formula / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedInput schema / properties / formula / type
      Added value: +"string"
    • removedInput schema / properties / name / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedInput schema / properties / name / type
      Added value: +"string"
    • changedInput schema / properties / options / anyOf
      Previous value: -[
      -  {
      -    "properties": {
      -      "choices": {
      -        "items": {
      -          "properties": {
      -            "color": {
      -              "description": "The hex color code for the choice (e.g. #ff0000).",
      -              "type": "string"
      -            },
      -            "value": {
      -              "description": "The display value of the choice. For 'dropdown' fields, this is the value that will be set on entities when this choice is selected.",
      -              "type": "string"
      -            }
      -          },
      -          "type": "object"
      -        },
      -        "type": "array"
      -      }
      -    },
      -    "type": "object"
      -  },
      -  {
      -    "properties": {
      -      "color": {
      -        "description": "The hex color code for the rating icons (e.g. #ff0000).",
      -        "type": "string"
      -      },
      -      "icon": {
      -        "description": "The icon to use for the rating, e.g. 'star', 'heart', etc.",
      -        "type": "string"
      -      }
      -    },
      -    "type": "object"
      -  },
      -  {
      -    "properties": {
      -      "decimals": {
      -        "description": "The number of decimal places to allow for number-decimal custom fields.",
      -        "type": "integer"
      -      }
      -    },
      -    "type": "object"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]New value: +[
      +  {
      +    "properties": {
      +      "choices": {
      +        "items": {
      +          "properties": {
      +            "color": {
      +              "description": "The hex color code for the choice (e.g. #ff0000).",
      +              "type": "string"
      +            },
      +            "value": {
      +              "description": "The display value of the choice. For 'dropdown' fields, this is the value that will be set on entities when this choice is selected.",
      +              "type": "string"
      +            }
      +          },
      +          "type": "object"
      +        },
      +        "type": "array"
      +      }
      +    },
      +    "type": "object"
      +  },
      +  {
      +    "properties": {
      +      "color": {
      +        "description": "The hex color code for the rating icons (e.g. #ff0000).",
      +        "type": "string"
      +      },
      +      "icon": {
      +        "description": "The icon to use for the rating, e.g. 'star', 'heart', etc.",
      +        "type": "string"
      +      }
      +    },
      +    "type": "object"
      +  },
      +  {
      +    "properties": {
      +      "decimals": {
      +        "description": "The number of decimal places to allow for number-decimal custom fields.",
      +        "type": "integer"
      +      }
      +    },
      +    "type": "object"
      +  }
      +]
    • removedInput schema / properties / required / anyOf
      Removed value: -[
      -  {
      -    "type": "boolean"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedInput schema / properties / required / type
      Added value: +"boolean"
    • removedInput schema / properties / unit / anyOf
      Removed value: -[
      -  {
      -    "enum": [
      -      "currency",
      -      "duration",
      -      "date",
      -      "percent",
      -      "currency/duration",
      -      "duration/currency"
      -    ],
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedInput schema / properties / unit / enum
      Added value: +[
      +  "currency",
      +  "duration",
      +  "date",
      +  "percent",
      +  "currency/duration",
      +  "duration/currency"
      +]
    • addedInput schema / properties / unit / type
      Added value: +"string"
  2. Addedv1.26.0
  3. Removedv1.25.0
  4. Addedv1.19.0

TDQS

C2.7/5.0
Behavior2/5

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

Annotations already indicate this is not a read-only or idempotent operation and not particularly destructive. The description adds no behavioral context beyond the word 'Update'—it doesn't mention side effects, type-specific constraints, permission needs, or what happens to existing field settings.

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

Conciseness2/5

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

At three words, the description is extremely terse, but this is under-specification rather than effective conciseness. It conveys no more than the tool name and title, and fails to use the available space to add context for a tool with 8 parameters and a nested options structure.

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?

Given that there is no output schema and this is a mutation tool with a rich input schema, the description is far too minimal. It doesn't explain update semantics, which fields cannot be changed, whether omitted fields are preserved, or what the response looks like, so an agent lacks operational context for correct invocation.

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 every parameter already has a meaningful description. The tool description itself adds no parameter-level meaning, but the baseline of 3 is appropriate because the schema carries the full burden.

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?

The description clearly states the verb 'Update' targeting the resource 'custom field', so an agent can tell this is an update operation on a custom field. However, it does not differentiate among sibling tools like update_custom_field_value or update_custom_item_field, so the purpose is clear but not contextually distinct.

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 usage context is provided. The description doesn't explain when to use this tool versus create_custom_field, update_custom_field_value, or other custom-field-related siblings, and it gives no exclusions or alternative 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