Skip to main content
Glama

Set OS patch policy

set_os_patch_policy
Destructive

Change an Ankra-provisioned cluster's rolling OS patch policy. mode sets how the cluster gets OS updates: automatic lets the platform start the rolling run_os_patches on its own inside the maintenance window, at most once per cadence_days (one node at a time, drained, stopping on the first failure); advisory means nothing patches it on its own and a person starts the run (the dry run and the package findings still report what is pending); default clears the choice so the cluster's purpose decides: automatic for a cluster a person labelled non-production (only 14 days after the organisation is told), advisory for production and for a label nobody chose. enabled is the older spelling (true is automatic, false advisory). Control planes and the bastion follow the cluster; node_group_modes overrides it per node group (automatic, advisory, or inherit to follow the cluster again), so one node group of a production cluster can be automatic. Automatic hosts keep Ankra's update hold on the packages the run patches; making hosts advisory removes the hold from them so unattended-upgrades patches them again, and is refused while a run is in progress. The window opens on window_days at window_start_hour_utc and stays open window_duration_hours (1-12); a run only starts inside it and may finish after it. include_stateful_nodes lets runs drain nodes carrying single-replica workloads with volumes; security_lag_days (1-90) is how long held-back security updates may stay pending before the cluster reports a security lag. Only the members you pass change; the rest keep their stored values. The defaults are no chosen mode, Monday to Thursday 02:00-06:00 UTC, weekly, stateful nodes skipped, 14 days.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "set_os_patch_policy"
  }
}

Input Schema

NameRequiredDescriptionDefault
modeNoHow the cluster gets OS updates: automatic (the rolling run in the window), advisory (a person starts it), or default (follow the cluster's environment).
enabledNoThe older spelling of mode: true is automatic, false advisory.
cluster_idNoUUID of the cluster. Optional when a cluster is selected.
window_daysNoThe UTC days the window opens on.
cadence_daysNoThe minimum number of days between two automatic runs.
cluster_nameNoExact name of the cluster. Optional when a cluster is selected.
node_group_modesNoPer node group overrides, by node group name: automatic, advisory, or inherit to follow the cluster. Groups not named keep their override.
security_lag_daysNoDays held-back security updates may stay pending before the cluster reports a security lag.
window_duration_hoursNoHow many hours the window stays open.
window_start_hour_utcNoThe UTC hour the window opens.
include_stateful_nodesNoLet runs drain nodes carrying single-replica workloads with volumes or belonging to a database node pool.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changed
    • changedInput schema / properties / enabled / description
      Previous value: -"Let the platform start patch runs on its own inside the window."New value: +"The older spelling of mode: true is automatic, false advisory."
    • addedInput schema / properties / mode
      Added value: +{
      +  "description": "How the cluster gets OS updates: automatic (the rolling run in the window), advisory (a person starts it), or default (follow the cluster's environment).",
      +  "enum": [
      +    "automatic",
      +    "advisory",
      +    "default"
      +  ],
      +  "type": "string"
      +}
    • addedInput schema / properties / node_group_modes
      Added value: +{
      +  "additionalProperties": {
      +    "enum": [
      +      "automatic",
      +      "advisory",
      +      "inherit"
      +    ],
      +    "type": "string"
      +  },
      +  "description": "Per node group overrides, by node group name: automatic, advisory, or inherit to follow the cluster. Groups not named keep their override.",
      +  "type": "object"
      +}
  2. Added

TDQS

A4.7/5.0
Behavior5/5

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

Beyond the destructive and non-idempotent annotations, the description explains automatic run cadence, one-node-at-a-time draining, failure stopping, advisory behavior, default resolution by cluster label, node-group overrides, update-hold effects, and the refusal during an active run. It also states that only supplied members change and gives the stored defaults.

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 purpose is front-loaded and almost every sentence carries useful policy semantics. The paragraph is nevertheless very dense and long, which makes some parameter interactions harder to scan than they need to be.

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

Completeness5/5

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

For an 11-parameter destructive policy mutation with a nested node-group object and no output schema, the description covers the important side effects, defaults, overrides, refusal conditions, and label-based default resolution. An agent has enough context to invoke it safely and correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is already 100%, but the description adds substantial meaning: enabled is an older spelling, node_group_modes supports inherit and per-group overrides, the window constrains run starts but not finishes, include_stateful_nodes affects draining, and security_lag_days controls security-lag reporting.

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: change a cluster's rolling OS patch policy. It distinguishes the policy-setting action from run_os_patches and clarifies how automatic and advisory modes relate to that separate run operation.

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 explains when automatic versus advisory mode applies, what default means, and that removing the hold is refused while a run is in progress. It does not explicitly say to use run_os_patches instead when the user wants to start a patch run immediately, but the alternative is strongly implied.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.