tool MCPlatest

`search_panes`

search_panes( max_lines?: integer, max_matches_per_pane?: integer, pattern: string, regex?: boolean, )

tool [source]¶

Read pane output; accepts no client-supplied executable input. Returned content may be sensitive or untrusted. Searches the visible output of every pane.

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

Arguments#

max_lines? (integer) #

maximum matching panes to return

maximum
200
max_matches_per_pane? (integer) #

maximum matching lines per pane

maximum
200
pattern (string) #

bounded text or regular expression to search for

maxLength
4096
regex? (boolean) #

treat pattern as a regular expression

No other arguments are accepted.

Result#

Returns object

bytesInspected (integer) #
linesInspected (integer) #
morePanes? (integer) #
panes (Array<object>) #
- Items (object) #
  - matches (Array<object>) #
    - Items (object) #
      - row (integer) #
      - text (string) #
      No other properties are accepted.
  - moreMatches? (integer) #
  - pane (object) #
    - active (boolean) #
    - currentCommand (string) #
    - geometry (object) #
      - height (integer) #
      - left (integer) #
      - top (integer) #
      - width (integer) #
      No other properties are accepted.
    - id (string) #
    - index (integer) #
    - isCaller (null | boolean) #
    - session (string) #
    - window (string) #
    - windowId (string) #
    No other properties are accepted.
  No other properties are accepted.
panesInspected (integer) #
workLimited (boolean) #
workTimeLimitSeconds (number) #

No other properties are accepted.

Annotations#

destructiveHint: true
idempotentHint: false
openWorldHint: true
readOnlyHint: false
title: "Search panes"

Protocol data#

Use the complete advertised contract for validation and client integration.

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

Scripting & web

Compiled & native

JVM

.NET

BEAM

tmux

`search_panes`

Arguments#

Result#

Annotations#

Protocol data#