Control Plane

Workload — Stop a Replica

workload_stop_replica

Destructive

Terminate a single running replica (pod) of a workload by issuing a stopReplica command — useful to recycle a wedged or unhealthy replica. The platform reschedules a replacement per the workload’s scaling, so this interrupts only in-flight work on that one replica; it does not delete the workload or any persistent data. Replica names: list_workload_replicas. Track the command with get_command.

Input Schema

TableJSON Schema

Name	Required	Description
`gvc`	Yes	GVC slug. If the user named none, list_resources (kind "gvc") and let them choose.
`org`	No	Organization slug.
`name`	Yes	Workload name. Immutable: renaming is delete and recreate, which loses the URL and internal DNS.
`replica`	Yes	Exact replica (pod) name to terminate. Discover names with list_workload_replicas.
`location`	Yes	Location where the replica runs — must be a location where this workload is deployed (see list_deployments).

Output Schema

TableJSON Schema

Name	Required	Description
`ok`	Yes
`data`	No	The full result. Read this, not only the summary.
`details`	No
`summary`	Yes
`nextSteps`	No

Schema Changelog

Changes observed during successful MCP inspections.

Changed25 schema fields changedSep 30, 2026

removedInput schema / $schema

Removed value: -"http://json-schema.org/draft-07/schema#"

removedInput schema / additionalProperties
```
Removed value: -false
```

changedInput schema / properties / gvc / description

Previous value: -"GVC slug (lowercase kebab-case). Use the GVC the user named; otherwise discover with list_resources (kind=\"gvc\") and let them choose — never guess (a wrong GVC targets the wrong environment)."New value: +"GVC slug. If the user named none, list_resources (kind \"gvc\") and let them choose."

removedInput schema / properties / gvc / maxLength
```
Removed value: -63
```
removedInput schema / properties / gvc / minLength
```
Removed value: -1
```

removedInput schema / properties / gvc / pattern

Removed value: -"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$"

removedInput schema / properties / location / minLength
```
Removed value: -1
```

changedInput schema / properties / name / description

Previous value: -"Workload name (lowercase kebab-case, must start with a letter, max 49 chars, cannot end with -headless). The name is IMMUTABLE — \"renaming\" requires delete + recreate (loses public URL, internal DNS, policy targetLinks)."New value: +"Workload name. Immutable: renaming is delete and recreate, which loses the URL and internal DNS."

removedInput schema / properties / name / maxLength
```
Removed value: -49
```
removedInput schema / properties / name / minLength
```
Removed value: -2
```
removedInput schema / properties / name / pattern
```
Removed value: -"^[a-z]([-a-z0-9])*[a-z0-9]$"
```

changedInput schema / properties / org / description

Previous value: -"Organization slug (lowercase kebab-case). NEVER guess — if the user has not named one, ask. On org-not-found, stop and ask; do not retry variants."New value: +"Organization slug."

removedInput schema / properties / org / maxLength
```
Removed value: -63
```
removedInput schema / properties / org / minLength
```
Removed value: -1
```

removedInput schema / properties / org / pattern

Removed value: -"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$"

removedInput schema / properties / replica / maxLength
```
Removed value: -253
```
removedInput schema / properties / replica / minLength
```
Removed value: -1
```

changedInput schema / required

Previous value: -[
-  "org",
-  "gvc",
-  "name",
-  "location",
-  "replica"
-]New value: +[
+  "gvc",
+  "name",
+  "location",
+  "replica"
+]

removedOutput schema / $schema

Removed value: -"http://json-schema.org/draft-07/schema#"

removedOutput schema / additionalProperties
```
Removed value: -false
```

changedOutput schema / properties / data / description

Previous value: -"The full machine-readable result — list rows, the resource object, query results. Read THIS, not just the summary."New value: +"The full result. Read this, not only the summary."

addedOutput schema / properties / details
```
Added value: +{
+  "type": "string"
+}
```

removedOutput schema / properties / nextSteps / description

Removed value: -"Recommended follow-up actions for this task, in order."

removedOutput schema / properties / ok / description
```
Removed value: -"Whether the call succeeded."
```
removedOutput schema / properties / summary / description
```
Removed value: -"One-line summary of the result."
```

AddedAug 14, 2026

TDQS

A4.5/5.0

Behavior5/5

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

Annotations already declare destructiveHint=true, and the description meaningfully qualifies that scope: the platform reschedules a replacement per scaling, only in-flight work on that replica is interrupted, and neither the workload nor persistent data is deleted. That is precisely the nuance an agent needs before calling a destructive tool, and it is not derivable from the annotations.

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 sentences, zero waste: the action and command come first, then the blast radius, then the two helper tools. Every sentence earns its place and the most important qualifier (limited blast radius) is front-loaded.

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?

An output schema exists, so return values need no explanation, and the description covers action, prerequisite discovery, effect, and follow-up tracking. Nothing needed to invoke this correctly against a 5-param schema 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 description coverage is 100% and the schema descriptions already carry the tooling hints ('Discover names with list_workload_replicas', 'see list_deployments'), so the description adds little parameter-level meaning. Baseline 3 applies when the schema does the heavy lifting.

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 — terminate one running replica (pod) via a `stopReplica` command — plus the scope of that action. It is clearly distinguishable from siblings like `restart_workload` or `delete_resource` without opening any schema.

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?

Gives a concrete use case ('recycle a wedged or unhealthy replica') and routes the agent to `list_workload_replicas` for names and `get_command` for tracking. It stops short of an explicit exclusion, e.g. when to prefer `restart_workload` or a full workload deletion instead, so it is clear context without full when-not guidance.

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

All Control Plane tools Inspect

Try in Browser

One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.