wait_for_channel

Java

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

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

All Java tools · JSON · Source

Arguments

channel required · string: A server-wide tmux channel name.
drain_first optional · boolean: Consume a pending signal before waiting. Defaults to false.
Default: false.
timeout optional · number: Seconds to wait before giving up. Defaults to 30.0.
Default: 30.

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": {
      "default": false,
      "description": "Consume a pending signal before waiting. Defaults to false.",
      "type": "boolean"
    },
    "timeout": {
      "default": 30,
      "description": "Seconds to wait before giving up. Defaults to 30.0.",
      "type": "number"
    }
  },
  "required": [
    "channel"
  ],
  "type": "object"
}

Output schema

{
  "additionalProperties": false,
  "properties": {
    "channel": {
      "type": "string"
    },
    "effective_timeout": {
      "type": "number"
    },
    "note": {
      "type": "string"
    },
    "outcome": {
      "type": "string"
    },
    "seconds": {
      "type": "number"
    }
  },
  "required": [
    "channel",
    "outcome",
    "seconds",
    "effective_timeout"
  ],
  "type": "object"
}

Tool annotations

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