Skip to main content
Glama
Cutover MCP

Cutover MCP

Official
by gocutover

Archive Custom Field

archive_custom_field

Archives a custom field to prevent further use while preserving existing values on runbooks and tasks; requires Custom Fields Admin or Global Admin.

Instructions

Archive a custom field so it can no longer be used. Existing values stay on runbooks and tasks. 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": "archive_custom_field"
  }
}

Input Schema

NameRequiredDescriptionDefault
custom_field_idYesThe ID of the field to archive (from list_custom_fields).

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.2/5.0
Behavior4/5

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

With no annotations provided, the description carries the burden and discloses the key mutation effect: the field becomes unusable while existing values remain on runbooks and tasks. It also states the authorization requirement, though it does not clarify reversibility or idempotency.

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?

The description is three tight sentences with no wasted wording. The main action is front-loaded, followed by consequence and authorization requirement.

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 simple one-parameter archive operation with an output schema, the description covers purpose, side effect, and permissions sufficiently. The main remaining gap is whether archiving can be reversed.

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 the single parameter custom_field_id is already documented in the input schema. The description adds no additional parameter-level meaning beyond pointing to the archive action.

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?

The description states a specific verb and resource: archive a custom field. It also clarifies the outcome, that the field can no longer be used, and names the resource precisely enough to distinguish it from archive_custom_field_group.

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?

It gives clear usage context by explaining the disabling effect and the required Custom Fields Admin or Global Admin role. It does not explicitly compare against alternatives such as update_custom_field or describe when not to archive, but the intended use is clear.

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