Skip to main content
Glama
Cloady

Cloady

Official
by Cloady

Stream Active Deploy

streamActiveDeploy
Read-only

Read an app's in-flight deployment or most recent one, and optionally stream live updates every two seconds until it finishes.

Instructions

Read the app's in-flight deploy, or its latest when none is running. Returns one {ts, deploy} frame: the active deploy if one is running, otherwise the most recent, and deploy is null when the app has never deployed. Sending Accept: text/event-stream instead follows it live, a frame every two seconds, closing after one terminal frame.

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": {
      "workspaceSlug": "<workspaceSlug>",
      "appSlug": "<appSlug>"
    },
    "name": "streamActiveDeploy"
  }
}

Input Schema

NameRequiredDescriptionDefault
envNo
regionNo
appSlugYes
workspaceSlugYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.5.1

TDQS

A4.3/5.0
Behavior5/5

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

Goes well beyond the readOnly/destructive annotations: it specifies the single-frame return envelope `{ts, deploy}`, the null case, and the SSE behavior including a two-second frame cadence and termination after one terminal frame. That is exactly the runtime behavior an agent cannot infer from annotations or schema.

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?

Two tight sentences, front-loaded with the core semantics, then the return shape, then the streaming variant. Every clause carries distinct information; nothing is restated from the name or title.

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?

With no output schema, the description correctly takes on responsibility for describing the return value and the streaming lifecycle, which it does well. The remaining gap is the unexplained `env` and `region` filters, which matter for a tool whose whole output is one scoped deploy frame.

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

Parameters2/5

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

Schema description coverage is 0% across four parameters, and the description never explains what `env` or `region` do — notably whether `env` selects which environment's deploy is streamed. Only appSlug/workspaceSlug are obliquely implied by 'the app's', leaving half the parameters undocumented in both structured and natural-language form.

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 with explicit scope: 'Read the app's in-flight deploy, or its latest when none is running.' It also pins down the degenerate case (`deploy` is null when never deployed), so an agent knows exactly what this returns without opening the 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?

Clearly frames the use case as checking current/latest deploy state and explains the alternate mode via `Accept: text/event-stream`. It does not name siblings such as listDeploys or streamDeployLogs to route the agent away from this tool for historical listings, so the alternative-selection guidance is implicit rather than explicit.

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

Deploy Server

Other Tools