search_panes

Swift

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. Search bounded pane content for literal text or a regular expression.

All Swift tools · JSON · Source

Arguments

maxMatchesPerPane optional · integer: Caller-controlled maxMatchesPerPane.
pattern required · string: Caller-controlled pattern.
regex optional · boolean: Caller-controlled regex.
scrollbackLines optional · integer: Caller-controlled scrollbackLines.
session optional · string: Caller-controlled session.

Schemas

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

Input schema

{
  "additionalProperties": false,
  "properties": {
    "maxMatchesPerPane": {
      "description": "Caller-controlled maxMatchesPerPane.",
      "maximum": 200,
      "minimum": 1,
      "type": "integer"
    },
    "pattern": {
      "description": "Caller-controlled pattern.",
      "type": "string",
      "x-libtmux-max-utf8-bytes": 4096
    },
    "regex": {
      "description": "Caller-controlled regex.",
      "type": "boolean"
    },
    "scrollbackLines": {
      "description": "Caller-controlled scrollbackLines.",
      "maximum": 2000,
      "minimum": 1,
      "type": "integer"
    },
    "session": {
      "description": "Caller-controlled session.",
      "type": "string"
    }
  },
  "required": [
    "pattern"
  ],
  "type": "object"
}

Output schema

{
  "additionalProperties": false,
  "properties": {
    "matches": {
      "items": {
        "additionalProperties": false,
        "properties": {
          "line": {
            "type": "integer"
          },
          "pane": {
            "type": "string"
          },
          "paneRef": {
            "type": "string"
          },
          "text": {
            "type": "string"
          }
        },
        "required": [
          "line",
          "pane",
          "paneRef",
          "text"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "panesAvailable": {
      "type": "integer"
    },
    "panesSearched": {
      "type": "integer"
    },
    "truncated": {
      "type": "boolean"
    },
    "truncatedBy": {
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  },
  "required": [
    "matches",
    "panesAvailable",
    "panesSearched",
    "truncated",
    "truncatedBy"
  ],
  "type": "object"
}

Tool annotations

{
  "destructiveHint": true,
  "idempotentHint": false,
  "openWorldHint": true,
  "readOnlyHint": false,
  "title": "Search panes"
}