tool MCPlatest

`search_panes`

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

tool [source]¶

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

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

Arguments#

max_lines? = 200 (integer) #

Maximum matches across all panes. Defaults to 200.
max_matches_per_pane? = 5 (integer) #

Maximum matching lines per pane. Defaults to 5.
pattern (string) #

The bounded text or regular expression to search for.

maxLength
4096
regex? = false (boolean) #

Treat pattern as a regular expression. Defaults to false.

No other arguments are accepted.

Result#

Returns object

bytes_searched (integer) #
count (integer) #
lines_searched (integer) #
matches (Array<object>) #
- Items (object) #
  - line (string) #
  - pane_id (string) #
  - session (string) #
  - window (string) #
  No other properties are accepted.
note? (string) #
panes_searched (integer) #
truncated (boolean) #
work_seconds (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": {
      "default": 200,
      "description": "Maximum matches across all panes. Defaults to 200.",
      "type": "integer"
    },
    "max_matches_per_pane": {
      "default": 5,
      "description": "Maximum matching lines per pane. Defaults to 5.",
      "type": "integer"
    },
    "pattern": {
      "description": "The bounded text or regular expression to search for.",
      "maxLength": 4096,
      "type": "string"
    },
    "regex": {
      "default": false,
      "description": "Treat pattern as a regular expression. Defaults to false.",
      "type": "boolean"
    }
  },
  "required": [
    "pattern"
  ],
  "type": "object"
}

Output schema

{
  "additionalProperties": false,
  "properties": {
    "bytes_searched": {
      "type": "integer"
    },
    "count": {
      "type": "integer"
    },
    "lines_searched": {
      "type": "integer"
    },
    "matches": {
      "items": {
        "additionalProperties": false,
        "properties": {
          "line": {
            "type": "string"
          },
          "pane_id": {
            "type": "string"
          },
          "session": {
            "type": "string"
          },
          "window": {
            "type": "string"
          }
        },
        "required": [
          "pane_id",
          "session",
          "window",
          "line"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "note": {
      "type": "string"
    },
    "panes_searched": {
      "type": "integer"
    },
    "truncated": {
      "type": "boolean"
    },
    "work_seconds": {
      "type": "number"
    }
  },
  "required": [
    "count",
    "panes_searched",
    "lines_searched",
    "bytes_searched",
    "work_seconds",
    "truncated",
    "matches"
  ],
  "type": "object"
}

Scripting & web

Compiled & native

JVM

.NET

BEAM

tmux

`search_panes`

Arguments#

Result#

Annotations#

Protocol data#