MCPconceptTools

Choose documentation 3

latest

Current version

latest
English

Early release libtmux is released, and its APIs may still change between releases. This site's structure and URLs may change too.

tool MCPlatest

wait_for_channel

wait_for_channel( channel: string, drain_first?: boolean, timeout?: number, )
tool [source]

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

MCP request method
tools/call Send wait_for_channel as the tool name, with the arguments below.

Arguments#

No other arguments are accepted.

Result#

Returns object

No other properties are accepted.

Annotations#

destructiveHint
true
idempotentHint
false
openWorldHint
true
readOnlyHint
false
title
"Wait for a channel"

Protocol data#

Use the complete advertised contract for validation and client integration.

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"
}
Esc

Type to search.

Reference previewOpen reference