Skip to main content
Glama
Cutover MCP

Cutover MCP

Official
by gocutover

Update Custom Field

update_custom_field

Modifies an existing custom field's settings, such as name, default value, required status, display options, and type constraints, without changing its type or workspace.

Instructions

Update a custom field definition. Only the parameters you pass are changed. The field's type, apply_to and workspace cannot be changed; create a new field instead.

Requires the Custom Fields Admin role (or Global Admin).

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "custom_field_id": "<custom_field_id>"
    },
    "name": "update_custom_field"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameNoThe new name.
requiredNoWhether a value must be given.
display_listNoShow the value as a pill in runbook and task lists.
default_valueNoThe value a new runbook or task starts with.
display_tableNoInclude the field in table views.
task_type_idsNoReplace the task type constraints with these task types. The runbook type constraints are kept.
display_searchNoAllow filtering by this field.
custom_field_idYesThe ID of the field to update (from list_custom_fields).
runbook_type_idsNoReplace the runbook type constraints with these runbook types. The task type constraints are kept. The Cutover API rejects an empty constraint list, so constraints cannot be cleared here; archive the field and create a new one instead.
add_field_optionsNoOption names to add to a select_menu, radiobox or checkboxes field. Existing options are kept. Options cannot be renamed or removed through the API.
allow_field_creationNoLet users add options from within a runbook.
custom_field_group_idNoMove the field into this group. Pass "" to take it out of its group. When omitted the field stays in its current group.

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.1/5.0
Behavior4/5

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

With no annotations supplied, the description carries the full burden and does real work: it discloses PATCH-style partial-update semantics, three immutable attributes, and an admin-role authorization requirement. It stops short of describing error behavior or side effects on existing field values when a definition changes.

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

Conciseness5/5

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

Three short sentences, front-loaded with the action and patch semantics, followed by the immutability limit and the permission requirement. No filler, and each sentence carries distinct information.

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

Completeness4/5

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

For a 12-parameter mutation with an output schema and fully documented parameters, the description covers the key operational facts: partial update, immutable fields, and required role. The remaining gap is the omitted-versus-null distinction, plus no note on how constraint replacement interacts with the empty-list rejection.

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, and the description genuinely adds meaning beyond the schema by stating that unpassed parameters are left untouched. It does not resolve the ambiguity of what an explicit null means versus an omitted parameter, which matters given every optional field defaults to null.

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?

"Update a custom field definition" states a specific verb and resource, and the immutability sentence tells the agent which edits are out of scope. It does not name create_custom_field explicitly, saying only "create a new field instead," so sibling routing is implied rather than spelled out.

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?

The description clearly frames this as a partial update ("Only the parameters you pass are changed") and redirects unsupported changes of type, apply_to and workspace to field creation. It gives no guidance on when to prefer archiving over updating, and it does not point to list_custom_fields for obtaining the ID, though the schema does.

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