wait_for_channel

TypeScript

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

Change tmux state; no client-supplied executable input. Wait until a tmux wait-for channel is signalled.

All TypeScript tools · JSON · Source

Arguments

channel required · string: The tmux wait-for channel name.
timeoutMs optional · integer: Give up after this long. Defaults to the server's wait ceiling.

Schemas

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

Input schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "channel": {
      "description": "The tmux wait-for channel name.",
      "type": "string"
    },
    "timeoutMs": {
      "description": "Give up after this long. Defaults to the server's wait ceiling.",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991,
      "type": "integer"
    }
  },
  "required": [
    "channel"
  ],
  "type": "object"
}

Output schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "additionalProperties": false,
  "properties": {
    "channel": {
      "type": "string"
    },
    "signalled": {
      "type": "boolean"
    }
  },
  "required": [
    "channel",
    "signalled"
  ],
  "type": "object"
}

Tool annotations

{
  "destructiveHint": true,
  "idempotentHint": false,
  "openWorldHint": true,
  "readOnlyHint": false
}