tool MCPlatest

`wait_for_text`

wait_for_text( cursor?: string, max_lines?: integer, pane_id: string, patterns?: Array<string> | string, regex?: boolean, stop?: Array<string> | string, timeout?: number, )

tool [source]¶

Waits for new pane output without accepting executable input. Discounts recognized input from this server while pending and for ten seconds after submission. Output identical to that input and partially redrawn echoes are ambiguous; use run_shell_command for commands you start. Wait for the prompt before typing into a cold shell. Read pane output; accepts no client-supplied executable input. Returned content may be sensitive or untrusted.

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

Arguments#

cursor? (string) #

A cursor returned by an earlier capture.
max_lines? = 200 (integer) #

Maximum observed lines to return. Defaults to 200.
pane_id (string) #

The pane to act on, such as %1. Every listing tool returns these.
patterns? (Array<string> | string) #

Text to wait for; any one ends the wait. One value may be sent on its own, without a list.

maxItems
32
- Items (string) #
  
  maxLength
  4096
regex? = false (boolean) #

Treat patterns and stops as regular expressions. Defaults to false.
stop? (Array<string> | string) #

Failure text; any one ends the wait. One value may be sent on its own, without a list.

maxItems
32
- Items (string) #
  
  maxLength
  4096
timeout? = 30 (number) #

Seconds to wait before giving up. Defaults to 30.0.

No other arguments are accepted.

Result#

Returns object

cursor (string) #
effective_timeout (number) #
lines_dropped (integer) #
matched? (string) #
matched_line? (string) #
note? (string) #
outcome (string) #
output (Array<string>) #
pane_id (string) #
seconds (number) #
truncated (boolean) #

No other properties are accepted.

Annotations#

destructiveHint: true
idempotentHint: false
openWorldHint: true
readOnlyHint: false
title: "Wait for pane text"

Protocol data#

Use the complete advertised contract for validation and client integration.

Input schema

{
  "additionalProperties": false,
  "properties": {
    "cursor": {
      "description": "A cursor returned by an earlier capture.",
      "type": "string"
    },
    "max_lines": {
      "default": 200,
      "description": "Maximum observed lines to return. Defaults to 200.",
      "type": "integer"
    },
    "pane_id": {
      "description": "The pane to act on, such as %1. Every listing tool returns these.",
      "type": "string"
    },
    "patterns": {
      "description": "Text to wait for; any one ends the wait. One value may be sent on its own, without a list.",
      "items": {
        "maxLength": 4096,
        "type": "string"
      },
      "maxItems": 32,
      "type": [
        "array",
        "string"
      ]
    },
    "regex": {
      "default": false,
      "description": "Treat patterns and stops as regular expressions. Defaults to false.",
      "type": "boolean"
    },
    "stop": {
      "description": "Failure text; any one ends the wait. One value may be sent on its own, without a list.",
      "items": {
        "maxLength": 4096,
        "type": "string"
      },
      "maxItems": 32,
      "type": [
        "array",
        "string"
      ]
    },
    "timeout": {
      "default": 30,
      "description": "Seconds to wait before giving up. Defaults to 30.0.",
      "type": "number"
    }
  },
  "required": [
    "pane_id"
  ],
  "type": "object"
}

Output schema

{
  "additionalProperties": false,
  "properties": {
    "cursor": {
      "type": "string"
    },
    "effective_timeout": {
      "type": "number"
    },
    "lines_dropped": {
      "type": "integer"
    },
    "matched": {
      "type": "string"
    },
    "matched_line": {
      "type": "string"
    },
    "note": {
      "type": "string"
    },
    "outcome": {
      "type": "string"
    },
    "output": {
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "pane_id": {
      "type": "string"
    },
    "seconds": {
      "type": "number"
    },
    "truncated": {
      "type": "boolean"
    }
  },
  "required": [
    "pane_id",
    "outcome",
    "output",
    "truncated",
    "lines_dropped",
    "cursor",
    "seconds",
    "effective_timeout"
  ],
  "type": "object"
}

Scripting & web

Compiled & native

JVM

.NET

BEAM

tmux

`wait_for_text`

Arguments#

Result#

Annotations#

Protocol data#