Skip to main content
Glama

Set cluster agent auto upgrade

set_cluster_agent_auto_upgrade
Destructive

Turn automatic upgrades of the Ankra agent on a cluster on or off (the twin of ankra cluster agent auto-upgrade enable|disable and the portal's cluster settings). With them on, the fleet rollout applies each new agent release to this cluster as soon as it has no write execution running; with them off the rollout skips this agent until they are turned back on, which is how a team fences a cluster off from agent releases for a freeze window or a migration night. 'enabled' is required and must be given explicitly: both directions are deliberate. Read the current setting with get_cluster_agent_status (disable_auto_upgrade); upgrade_cluster_agent applies a release on demand whichever way the switch sits. Every change is recorded in the audit log with who made it, the previous and new setting and the reason when one is given. Requires agents.manage.

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": {
      "enabled": "<enabled>"
    },
    "name": "set_cluster_agent_auto_upgrade"
  }
}

Input Schema

NameRequiredDescriptionDefault
reasonNoWhy the switch is being changed, in the operator's own words (a freeze window, a migration night, the end of one). Recorded on the change's audit row so the next person can see why the fence went up or came down. Optional.
enabledYestrue puts the agent back into the automatic fleet rollout; false fences it off until enabled again.
cluster_idNoUUID of the target cluster. Optional when a cluster is selected.
cluster_nameNoExact name of the target cluster. Optional when a cluster is selected.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / reason
      Added value: +{
      +  "description": "Why the switch is being changed, in the operator's own words (a freeze window, a migration night, the end of one). Recorded on the change's audit row so the next person can see why the fence went up or came down. Optional.",
      +  "type": "string"
      +}
  2. First observed

TDQS

A4.2/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=false and destructiveHint=true; the description adds genuinely useful behavior: the fleet rollout skips the agent while off, the change is audited with previous/new value and reason, and the call requires the agents.manage permission. It stops short of describing the response payload or what happens to an in-flight rollout when the switch flips, which is the main operational unknown for a mutation with a destructive hint.

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?

Front-loaded with the purpose, then consequences, then alternatives, then permissions — a sensible ordering. It is one dense block and the CLI/portal equivalence clause is somewhat redundant, but no sentence is filler.

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 a 4-parameter boolean toggle with no output schema, the description covers effect, prerequisites (agents.manage), audit trail, and sibling routing. Nothing an agent needs to call it correctly or safely is missing.

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 coverage is 100%, so the baseline is 3; the description adds only the rule that 'enabled' must be supplied explicitly and that 'reason' lands on the audit row. Target-cluster selection (cluster_id vs cluster_name) is left entirely to the schema.

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 ('Turn automatic upgrades of the Ankra agent on a cluster on or off') and maps itself to the equivalent CLI verb pair and portal setting. It also explicitly distinguishes itself from the two nearest siblings, so an agent can select it without inspecting schemas.

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?

Names concrete when-to-use scenarios (freeze window, migration night) and points to the exact alternatives: get_cluster_agent_status to read the current setting and upgrade_cluster_agent for an on-demand release. It also states the explicit-parameter requirement, which is the main misuse risk.

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.