search_panes

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. Searches the visible output of every pane.

All Go tools · JSON · Source

Arguments

max_lines optional · integer: maximum matching panes to return
max_matches_per_pane optional · integer: maximum matching lines per pane
pattern required · string: bounded text or regular expression to search for
regex optional · boolean: treat pattern as a regular expression

Schemas

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

Input schema

{
  "additionalProperties": false,
  "properties": {
    "max_lines": {
      "description": "maximum matching panes to return",
      "maximum": 200,
      "type": "integer"
    },
    "max_matches_per_pane": {
      "description": "maximum matching lines per pane",
      "maximum": 200,
      "type": "integer"
    },
    "pattern": {
      "description": "bounded text or regular expression to search for",
      "maxLength": 4096,
      "type": "string"
    },
    "regex": {
      "description": "treat pattern as a regular expression",
      "type": "boolean"
    }
  },
  "required": [
    "pattern"
  ],
  "type": "object"
}

Output schema

{
  "additionalProperties": false,
  "properties": {
    "bytesInspected": {
      "type": "integer"
    },
    "linesInspected": {
      "type": "integer"
    },
    "morePanes": {
      "type": "integer"
    },
    "panes": {
      "items": {
        "additionalProperties": false,
        "properties": {
          "matches": {
            "items": {
              "additionalProperties": false,
              "properties": {
                "row": {
                  "type": "integer"
                },
                "text": {
                  "type": "string"
                }
              },
              "required": [
                "row",
                "text"
              ],
              "type": "object"
            },
            "type": [
              "array"
            ]
          },
          "moreMatches": {
            "type": "integer"
          },
          "pane": {
            "additionalProperties": false,
            "properties": {
              "active": {
                "type": "boolean"
              },
              "currentCommand": {
                "type": "string"
              },
              "geometry": {
                "additionalProperties": false,
                "properties": {
                  "height": {
                    "type": "integer"
                  },
                  "left": {
                    "type": "integer"
                  },
                  "top": {
                    "type": "integer"
                  },
                  "width": {
                    "type": "integer"
                  }
                },
                "required": [
                  "left",
                  "top",
                  "width",
                  "height"
                ],
                "type": "object"
              },
              "id": {
                "type": "string"
              },
              "index": {
                "type": "integer"
              },
              "isCaller": {
                "type": [
                  "null",
                  "boolean"
                ]
              },
              "session": {
                "type": "string"
              },
              "window": {
                "type": "string"
              },
              "windowId": {
                "type": "string"
              }
            },
            "required": [
              "id",
              "session",
              "window",
              "windowId",
              "index",
              "currentCommand",
              "active",
              "geometry",
              "isCaller"
            ],
            "type": "object"
          }
        },
        "required": [
          "pane",
          "matches"
        ],
        "type": "object"
      },
      "type": [
        "array"
      ]
    },
    "panesInspected": {
      "type": "integer"
    },
    "workLimited": {
      "type": "boolean"
    },
    "workTimeLimitSeconds": {
      "type": "number"
    }
  },
  "required": [
    "panes",
    "panesInspected",
    "linesInspected",
    "bytesInspected",
    "workLimited",
    "workTimeLimitSeconds"
  ],
  "type": "object"
}

Tool annotations

{
  "destructiveHint": true,
  "openWorldHint": true,
  "title": "Search panes"
}