Skip to main content
Glama

Plan OS patches

plan_os_patches
Read-only

Dry-run the rolling OS security-patch lane on an Ankra-provisioned cluster (Hetzner, OVH, UpCloud, DigitalOcean, Scaleway, AWS or Ankra Cloud): on every node and the bastion it simulates the pending apt upgrades against the package lists the host already has and changes nothing. Ankra's unattended upgrades deliberately hold back the packages whose updates restart networking in place (systemd, udev, netplan, the container runtime, iptables/nftables), so their security fixes only arrive through run_os_patches; this shows what is waiting. Per host: the pending, security and held-back packages, whether a reboot is owed, how old the package lists are, and a stateful_verdict - would_skip names the single-replica workloads with volumes (or the database node pool) that make run_os_patches skip the node unless include_stateful_nodes is true. It also returns the order a run would take (control planes first, one at a time, then the workers, the bastion last), the hosts a run would leave out and why (a node that is not up, a cluster's only control plane), and the cluster's patch policy. A host whose status is not success has an unknown plan, not an empty one. It waits about 40 seconds for the hosts; when completed is false, call get_os_patch_status a minute later for the finished plan.

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": "plan_os_patches"
  }
}

Input Schema

NameRequiredDescriptionDefault
cluster_idNoUUID of the cluster. Optional when a cluster is selected.
cluster_nameNoExact name of the cluster. Optional when a cluster is selected.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.6/5.0
Behavior5/5

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

Beyond the readOnlyHint annotation, the description discloses that nothing is changed, that simulation uses package lists already on the host, why certain packages are held back, what per-host data is returned, how stateful_verdict and skip reasons work, what ordering a real run would use, that non-success host status means an unknown plan, and the roughly 40-second wait with polling guidance. This is unusually rich 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 front-loaded with the dry-run and no-change guarantee, and every sentence carries operational information. It is very dense and longer than typical, but the detail is justified by the tool's complexity; minor structural improvements could make it easier to scan.

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?

There is no output schema, but the description explains the returned plan in detail: per-host package status, reboot need, package-list age, stateful_verdict, run order, excluded hosts, and cluster patch policy. It also covers the completed=false edge case and polling path, leaving no critical gap for correct invocation.

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 cluster_id and cluster_name are already documented. The description mentions operating on an Ankra-provisioned cluster but does not add meaning about the two parameters or their optional selection behavior. Baseline 3 is appropriate.

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: "Dry-run the rolling OS security-patch lane" on an Ankra-provisioned cluster. It clearly scopes the operation to every node and the bastion, and distinguishes it from run_os_patches, which actually applies the held-back fixes.

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?

It explicitly explains when to use this tool: to see pending, security, and held-back packages before running run_os_patches. It also names the polling alternative, get_os_patch_status, when completed is false. No inference about the correct tool choice is left to the agent.

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.