MCPAPI Reference

Choose documentation 3

latest

Current version

latest
English

Prerelease This site documents an alpha of libtmux. Its structure, URLs and APIs are subject to change.

signal_channel

Signal a tmux wait-for channel, releasing every current waiter. With no waiter, one signal is latched; signalling the same channel again clears that latch. Change tmux state; no client-supplied executable input.

All Rust tools · JSON · Source

Arguments

channel required · string
The channel name, which is any string both sides agree on.
seconds optional · integer | null
How long to wait, in seconds. Defaults to 30, capped at 600.

Schemas

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

Input schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"channel": {
"description": "The channel name, which is any string both sides agree on.",
"type": "string"
},
"seconds": {
"description": "How long to wait, in seconds. Defaults to 30, capped at 600.",
"minimum": 0,
"type": [
"integer",
"null"
]
}
},
"required": [
"channel"
],
"type": "object"
}
Output schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"channel": {
"description": "The channel that was signalled.",
"type": "string"
}
},
"required": [
"channel"
],
"type": "object"
}
Tool annotations
{
"destructiveHint": false,
"idempotentHint": false,
"openWorldHint": false,
"readOnlyHint": false,
"title": "Signal Channel"
}
Esc

Type to search.