Skip to main content
Glama
Cutover MCP

Cutover MCP

Official
by gocutover

Create Custom Field

create_custom_field

Defines a new custom field for Cutover runbooks or tasks, choosing its type, placement and options so teams can capture required data. Check existing fields first to avoid duplicates.

Instructions

Create a custom field definition (the Custom Fields admin page). This defines a new field; to set a value on a runbook or task, use custom_field_values on the runbook and task tools.

Requires the Custom Fields Admin role (or Global Admin). Check list_custom_fields first so an existing field is reused rather than duplicated.

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": {
      "name": "<name>",
      "field_type": "<field_type>",
      "apply_to": "<apply_to>"
    },
    "name": "create_custom_field"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameYesThe field's name.
apply_toYesWhere the field appears: runbook_add_edit / runbook_edit (runbook details), runbook_page (runbook homepage), task_add_edit / task_edit (task details), task_start or task_end (asked when a task starts or finishes).
requiredNoWhether a value must be given.
field_typeYestext, textarea, select_menu, radiobox, checkboxes, datetime or user_select.
display_listNoShow the value as a pill in runbook and task lists.
global_fieldNoCreate the field for every workspace on the instance. Must be set explicitly, and only when the user asks for a global field, since every workspace sees it.
workspace_idNoThe workspace that owns the field. Required unless global_field is True.
default_valueNoThe value a new runbook or task starts with.
display_tableNoInclude the field in table views.
field_optionsNoOption names. Required for select_menu, radiobox and checkboxes, and not allowed for other field types.
task_type_idsNoLimit a task field to these task types (see list_task_types).
display_searchNoAllow filtering by this field.
runbook_type_idsNoLimit the field to these runbook types (see list_runbook_types).
allow_field_creationNoLet users add options from within a runbook.
custom_field_group_idNoThe group to show the field in (see list_custom_field_groups).

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.4/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 disclose the key operational gate: the Custom Fields Admin or Global Admin role requirement. The duplication-check instruction is also a real behavioral hint rather than a restatement of the name. It does not characterize failure modes or whether creation is reversible (archive_custom_field exists), which would have pushed this to a 5.

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 with no filler: purpose first, alternative surface second, prerequisite and permission third. Every sentence earns its place and nothing is buried.

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 15-parameter mutation tool with an output schema and fully documented inputs, the description covers purpose, authorization, and the main misuse risk. It stops short of describing runtime consequences such as global field visibility (left to the schema) or what happens after creation, which keeps it at a 4 rather than a 5.

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% and all 15 parameters, including both enums and the conditional workspace_id/global_field rule, are documented in the schema itself. The description adds no parameter-level meaning beyond that, so the baseline of 3 applies.

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

Purpose5/5

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

States a specific verb and resource ("Create a custom field definition") and immediately disambiguates from the sibling concern of setting values by naming custom_field_values on the runbook and task tools. An agent can tell this apart from update_custom_field and create_custom_field_group without opening any schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives an explicit pre-condition ("Check list_custom_fields first so an existing field is reused rather than duplicated") and explicitly redirects value-setting to a different surface. The only minor gap is that it does not contrast with update_custom_field for editing an existing definition, but the duplication check largely covers that.

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