wait_for_text

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

Read pane output; accepts no client-supplied executable input. Returned content may be sensitive or untrusted. Waits for new pane output without accepting executable input.

All Go tools · JSON · Source

Arguments

cursor optional · string: a cursor returned by an earlier capture
max_lines optional · integer: maximum observed lines to return
pane_id required · string: the pane id, such as %1
patterns optional · null | array: text to wait for; any one ends the wait
regex optional · boolean: treat patterns and stops as regular expressions
stop optional · null | array: failure text; any one ends the wait
timeout optional · number: seconds to wait before giving up

Schemas

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

Input schema

{
  "additionalProperties": false,
  "properties": {
    "cursor": {
      "description": "a cursor returned by an earlier capture",
      "type": "string"
    },
    "max_lines": {
      "description": "maximum observed lines to return",
      "type": "integer"
    },
    "pane_id": {
      "description": "the pane id, such as %1",
      "type": "string"
    },
    "patterns": {
      "description": "text to wait for; any one ends the wait",
      "items": {
        "maxLength": 4096,
        "type": "string"
      },
      "maxItems": 32,
      "type": [
        "null",
        "array"
      ]
    },
    "regex": {
      "description": "treat patterns and stops as regular expressions",
      "type": "boolean"
    },
    "stop": {
      "description": "failure text; any one ends the wait",
      "items": {
        "maxLength": 4096,
        "type": "string"
      },
      "maxItems": 32,
      "type": [
        "null",
        "array"
      ]
    },
    "timeout": {
      "description": "seconds to wait before giving up",
      "minimum": 0,
      "type": "number"
    }
  },
  "required": [
    "pane_id"
  ],
  "type": "object"
}

Output schema

{
  "additionalProperties": false,
  "properties": {
    "effectiveTimeoutSeconds": {
      "type": "integer"
    },
    "elapsedSeconds": {
      "type": "number"
    },
    "entryNote": {
      "type": "string"
    },
    "found": {
      "type": "boolean"
    },
    "lines": {
      "items": {
        "type": "string"
      },
      "type": [
        "array"
      ]
    },
    "matched": {
      "type": "string"
    },
    "matchedAtEntry": {
      "type": "boolean"
    },
    "outcome": {
      "type": "string"
    },
    "paneId": {
      "type": "string"
    },
    "pendingInputOnly": {
      "type": "boolean"
    },
    "timeoutClamped": {
      "type": "boolean"
    },
    "truncated": {
      "type": "boolean"
    },
    "truncatedBytes": {
      "type": "integer"
    },
    "truncatedLines": {
      "type": "integer"
    }
  },
  "required": [
    "paneId",
    "outcome",
    "found",
    "matchedAtEntry",
    "pendingInputOnly",
    "elapsedSeconds",
    "effectiveTimeoutSeconds",
    "truncated"
  ],
  "type": "object"
}

Tool annotations

{
  "destructiveHint": true,
  "openWorldHint": true,
  "title": "Wait for pane text"
}