tool MCPlatest

`search_panes`

search_panes( maxMatchesPerPane?: integer, pattern: string, regex?: boolean, scrollbackLines?: integer, session?: string, )

tool [source]¶

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.

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

Arguments#

maxMatchesPerPane? (integer) #

Caller-controlled maxMatchesPerPane.

minimum
1
maximum
200
pattern (string) #

Caller-controlled pattern.
regex? (boolean) #

Caller-controlled regex.
scrollbackLines? (integer) #

Caller-controlled scrollbackLines.

minimum
1
maximum
2000
session? (string) #

Caller-controlled session.

No other arguments are accepted.

Result#

Returns object

matches (Array<object>) #
- Items (object) #
  - line (integer) #
  - pane (string) #
  - paneRef (string) #
  - text (string) #
  No other properties are accepted.
panesAvailable (integer) #
panesSearched (integer) #
truncated (boolean) #
truncatedBy (Array<string>) #

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

Scripting & web

Compiled & native

JVM

.NET

BEAM

tmux

`search_panes`

Arguments#

Result#

Annotations#

Protocol data#