Skip to main content
Glama

Restart a Workload

restart_workload
Destructive

Restart a workload: every replica is replaced by a fresh one on the same spec (a rolling restart that re-reads secrets and env), then waits up to 40 seconds for it to be ready again. Not for cron workloads (workload_start_cron runs one now) or suspended ones. Get approval first: replicas restart.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
gvcYesGVC slug. If the user named none, list_resources (kind "gvc") and let them choose.
orgNoOrganization slug.
nameYesWorkload to restart.
waitSecondsNoSeconds to wait on the server until the workload is ready again, 0 to 45. The call returns as soon as it is, or with the latest state when the time runs out. Use this instead of calling again and again.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
okYes
dataNoThe full result. Read this, not only the summary.
detailsNo
summaryYes
nextStepsNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already declare destructiveHint=true and non-idempotent, so the description need not restate that. It adds real behavioral value beyond them: the rolling-restart mechanism, that secrets and env are re-read, the 40-second readiness wait, and a required approval step. It does not add rate limits or auth detail, so it stays below a 5.

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?

Three tightly packed sentences, front-loaded with the action and mechanism, then exclusions, then the approval prerequisite. No filler; every clause adds behavioral information.

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 mutation tool with annotations (destructive, non-idempotent), a rich schema, and an output schema (so return values need not be explained), this covers mechanism, exclusions, timing, and approval. Only minor gaps remain (e.g., what happens to in-flight requests during the restart), keeping it just short of complete.

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 every parameter is already documented, including the waitSeconds description that explains its semantics and range. The description adds only a default-style statement ('waits up to 40 seconds') that partially mirrors the waitSeconds schema. Baseline 3 is appropriate when the schema carries the parameter burden.

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 ('Restart a workload') and immediately defines the mechanism ('every replica is replaced by a fresh one on the same spec (a rolling restart that re-reads secrets and env)'), distinguishing it from siblings like rollback_workload, promote_workload, and workload_stop_replica. It also explicitly names cron and suspended workloads as out of scope, which no sibling does.

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 gives a clear when-not ('Not for cron workloads (workload_start_cron runs one now) or suspended ones') and an explicit prerequisite ('Get approval first: replicas restart.'). The alternative for cron (workload_start_cron) is named directly. This is explicit routing.

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.