Skip to main content
Glama
Cutover MCP

Cutover MCP

Official
by gocutover

Update Runbook

update_runbook

Update a runbook's fields, including name, status, schedule, RTO, folder, template settings, and custom dashboard values, by specifying its runbook ID.

Instructions

Update a specific runbook's fields.

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": {
      "runbook_id": "<runbook_id>"
    },
    "name": "update_runbook"
  }
}

Input Schema

NameRequiredDescriptionDefault
rtoNoRecovery Time Objective in seconds (optional).
nameNoThe new name for the runbook (optional).
statusNoThe new RAG status for the runbook (Allowed: off, red, amber, green).
timezoneNoIANA Timezone name (optional).
folder_idNoID of the folder to move the runbook to (optional, relationship field).
auto_startNoWhether to auto-start the runbook once start_scheduled is reached. Auto-started runbooks run in live mode with comms on.
runbook_idYesThe unique identifier for the runbook (required).
descriptionNoThe new description for the runbook (optional).
is_templateNoWhether the runbook is a template (optional, true/false).
rto_end_taskNoID of the end task for RTO/RTA feature (optional, relationship field).
end_scheduledNoISO 8601 timestamp for the runbook's scheduled end. Must be omitted if start_scheduled is not set.
rto_start_taskNoID of the start task for RTO/RTA feature (optional, relationship field).
master_templateNoWhether this runbook can be used to create app-specific templates from the Workspace Data Sources view. Requires is_template=True; the API rejects setting this on a non-template runbook. Do NOT respond to that rejection by also setting is_template=True in the same or a follow-up call unless the user explicitly asked for the runbook to become a template — silently converting a live runbook into a template is a significant, hard-to-reverse side effect. Surface the rejection and ask the user instead.
start_scheduledNoISO 8601 timestamp, or the literal string "now", to schedule the runbook's start. The scheduler ignores times in the past.
custom_field_valuesNoCustom field values to update, including the runbook dashboard fields on the runbook homepage (e.g. Executive summary, Additional notes), the Post-Implementation Review (PIR) and the Incident Review (e.g. Incident Summary, RCA, Lessons Learned). Identify each field by custom_field_id, using the id returned by list_custom_fields with scope="runbook": {"custom_field_id": "123", "value": ...}. A field's internal ``name`` (e.g. "dashboard:incident_review:lessons_learned") can be used instead of the id, but its ``display_name`` ("Lessons Learned") cannot. For select_menu and radiobox fields, pass the option name; for checkboxes, pass a list of option names. Pass "" to clear a field. Values in the response are listed by ``name``, with custom_field_id set to null.

Output Schema

NameRequiredDescriptionDefault
dataYes
includedNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

C2.9/5.0
Behavior2/5

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

No annotations are provided, so the description must carry the full behavioral burden for a mutation tool. It only says fields are updated, without explaining partial-update semantics, permissions, reversibility, side effects, or that omitted fields remain unchanged. The schema contains important cautions, but the description itself adds almost no behavioral context.

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?

The description is a single efficient sentence with no wasted wording. Its conciseness comes at the cost of under-specification, but structurally it is clear and front-loaded.

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?

This is a 15-parameter mutation tool with no annotations, despite the schema being rich and an output schema existing. A single generic sentence is not complete enough: it omits when to use the tool, partial-update behavior, and key safety guidance that an agent should know before mutating a runbook.

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 the input schema already documents all 15 parameters in detail, including allowed values and edge cases. The description adds no parameter meaning beyond the schema, making the baseline 3 appropriate.

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 gives a specific verb and resource ("Update a specific runbook"), which is clear enough for an agent to understand the operation. However, it does not distinguish this from related sibling operations such as manage_runbook or update_runbook_task, and the vague "fields" phrasing adds no scope detail.

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?

There is no guidance on when to use this tool versus alternatives, no prerequisites, and no mention of when not to use it. The description only states the action; it leaves routing and eligibility entirely to inference.

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