wait_for_channel

Python
Ruby Unavailable
Lua Unavailable
TypeScript
Rust
Go
Java
.NET
C++
Swift

Change tmux state; no client-supplied executable input. Waits on tmux’s channel state with a bounded timeout.

Arguments

channel required · string: a server-wide tmux channel name
drain_first optional · boolean: consume a pending signal before waiting
timeout optional · number: seconds to wait before giving up

Schemas

The schema defines required fields, nested values, defaults, and validation constraints.

Input schema

{
  "additionalProperties": false,
  "properties": {
    "channel": {
      "description": "a server-wide tmux channel name",
      "type": "string"
    },
    "drain_first": {
      "description": "consume a pending signal before waiting",
      "type": "boolean"
    },
    "timeout": {
      "description": "seconds to wait before giving up",
      "minimum": 0,
      "type": "number"
    }
  },
  "required": [
    "channel"
  ],
  "type": "object"
}

Output schema

{
  "additionalProperties": false,
  "properties": {
    "effectiveTimeoutSeconds": {
      "type": "integer"
    },
    "signalled": {
      "type": "boolean"
    },
    "timeoutClamped": {
      "type": "boolean"
    }
  },
  "required": [
    "signalled",
    "effectiveTimeoutSeconds"
  ],
  "type": "object"
}

Tool annotations

{
  "destructiveHint": true,
  "openWorldHint": true,
  "title": "Wait for a channel"
}