tool MCPlatest

`snapshot_pane`

snapshot_pane( maxLines?: integer, paneId: string, )

tool [source]¶

Read pane output; accepts no client-supplied executable input. Returned content may be sensitive or untrusted. Return bounded terminal content and pane metadata in one MCP response. The metadata and capture come from separate tmux requests and are not an atomic snapshot.

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

Arguments#

maxLines? (integer) #

Keep at most this many lines, from the end. Defaults to the server limit.

maximum
9007199254740991
exclusiveMinimum
0
paneId (string) #

Stable pane id, e.g. %1.

pattern
"^%\\d+$"

Result#

Returns object

content (string) #
cursorX (integer) #

minimum
-9007199254740991
maximum
9007199254740991
cursorY (integer) #

minimum
-9007199254740991
maximum
9007199254740991
droppedLines (integer) #

minimum
-9007199254740991
maximum
9007199254740991
inMode (integer) #

minimum
-9007199254740991
maximum
9007199254740991
pane (object) #
- active (boolean) #
  
  Whether this is its window’s active pane.
- command (string) #
  
  The command tmux reports running in it.
- cwd (string) #
  
  Its current working directory.
- dead (boolean) #
  
  Whether its process exited and remain-on-exit kept it.
- height (integer) #
  
  minimum
  -9007199254740991
  maximum
  9007199254740991
- id (string) #
  
  Stable pane id. Prefer this for entity-scoped targeting.
  
  pattern
  "^%\\d+$"
- index (integer) #
  
  minimum
  -9007199254740991
  maximum
  9007199254740991
- isAttended (boolean) #
  
  A person is currently looking at this pane.
- isCallerPane (boolean) #
  
  This is the pane this MCP server runs in.
- metadataComplete (boolean) #
  
  Whether every projected metadata string is complete.
- omittedMetadataBytes (integer) #
  
  UTF-8 bytes omitted from projected metadata strings.
  
  minimum
  0
  maximum
  9007199254740991
- omittedPlacements (integer) #
  
  Later placements omitted.
  
  minimum
  0
  maximum
  9007199254740991
- placements (Array<object>) #
  
  Retained session and window indexes through which this pane is reachable.
  - Items (object) #
    - index (integer) #
      
      The window index in this session.
      
      minimum
      -9007199254740991
      maximum
      9007199254740991
    - sessionId (string) #
      
      Stable session id, e.g. $1.
      
      pattern
      "^\\$\\d+$"
    - sessionName (string) #
    No other properties are accepted.
- placementsComplete (boolean) #
  
  Whether placements contains every placement.
- title (string) #
- width (integer) #
  
  minimum
  -9007199254740991
  maximum
  9007199254740991
- windowId (string) #
  
  Stable window id, e.g. @1.
  
  pattern
  "^@\\d+$"
- windowName (string) #
No other properties are accepted.
scrollPosition (integer) #

minimum
-9007199254740991
maximum
9007199254740991

No other properties are accepted.

Annotations#

destructiveHint: true
idempotentHint: false
openWorldHint: true
readOnlyHint: false

Protocol data#

Use the complete advertised contract for validation and client integration.

Input schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "maxLines": {
      "description": "Keep at most this many lines, from the end. Defaults to the server limit.",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991,
      "type": "integer"
    },
    "paneId": {
      "description": "Stable pane id, e.g. %1.",
      "pattern": "^%\\d+$",
      "type": "string"
    }
  },
  "required": [
    "paneId"
  ],
  "type": "object"
}

Output schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "additionalProperties": false,
  "properties": {
    "content": {
      "type": "string"
    },
    "cursorX": {
      "maximum": 9007199254740991,
      "minimum": -9007199254740991,
      "type": "integer"
    },
    "cursorY": {
      "maximum": 9007199254740991,
      "minimum": -9007199254740991,
      "type": "integer"
    },
    "droppedLines": {
      "maximum": 9007199254740991,
      "minimum": -9007199254740991,
      "type": "integer"
    },
    "inMode": {
      "maximum": 9007199254740991,
      "minimum": -9007199254740991,
      "type": "integer"
    },
    "pane": {
      "additionalProperties": false,
      "properties": {
        "active": {
          "description": "Whether this is its window's active pane.",
          "type": "boolean"
        },
        "command": {
          "description": "The command tmux reports running in it.",
          "type": "string"
        },
        "cwd": {
          "description": "Its current working directory.",
          "type": "string"
        },
        "dead": {
          "description": "Whether its process exited and remain-on-exit kept it.",
          "type": "boolean"
        },
        "height": {
          "maximum": 9007199254740991,
          "minimum": -9007199254740991,
          "type": "integer"
        },
        "id": {
          "description": "Stable pane id. Prefer this for entity-scoped targeting.",
          "pattern": "^%\\d+$",
          "type": "string"
        },
        "index": {
          "maximum": 9007199254740991,
          "minimum": -9007199254740991,
          "type": "integer"
        },
        "isAttended": {
          "description": "A person is currently looking at this pane.",
          "type": "boolean"
        },
        "isCallerPane": {
          "description": "This is the pane this MCP server runs in.",
          "type": "boolean"
        },
        "metadataComplete": {
          "description": "Whether every projected metadata string is complete.",
          "type": "boolean"
        },
        "omittedMetadataBytes": {
          "description": "UTF-8 bytes omitted from projected metadata strings.",
          "maximum": 9007199254740991,
          "minimum": 0,
          "type": "integer"
        },
        "omittedPlacements": {
          "description": "Later placements omitted.",
          "maximum": 9007199254740991,
          "minimum": 0,
          "type": "integer"
        },
        "placements": {
          "description": "Retained session and window indexes through which this pane is reachable.",
          "items": {
            "additionalProperties": false,
            "properties": {
              "index": {
                "description": "The window index in this session.",
                "maximum": 9007199254740991,
                "minimum": -9007199254740991,
                "type": "integer"
              },
              "sessionId": {
                "description": "Stable session id, e.g. $1.",
                "pattern": "^\\$\\d+$",
                "type": "string"
              },
              "sessionName": {
                "type": "string"
              }
            },
            "required": [
              "index",
              "sessionId",
              "sessionName"
            ],
            "type": "object"
          },
          "type": "array"
        },
        "placementsComplete": {
          "description": "Whether placements contains every placement.",
          "type": "boolean"
        },
        "title": {
          "type": "string"
        },
        "width": {
          "maximum": 9007199254740991,
          "minimum": -9007199254740991,
          "type": "integer"
        },
        "windowId": {
          "description": "Stable window id, e.g. @1.",
          "pattern": "^@\\d+$",
          "type": "string"
        },
        "windowName": {
          "type": "string"
        }
      },
      "required": [
        "active",
        "command",
        "cwd",
        "dead",
        "height",
        "id",
        "index",
        "isAttended",
        "isCallerPane",
        "metadataComplete",
        "omittedMetadataBytes",
        "omittedPlacements",
        "placements",
        "placementsComplete",
        "title",
        "width",
        "windowId",
        "windowName"
      ],
      "type": "object"
    },
    "scrollPosition": {
      "maximum": 9007199254740991,
      "minimum": -9007199254740991,
      "type": "integer"
    }
  },
  "required": [
    "content",
    "cursorX",
    "cursorY",
    "droppedLines",
    "inMode",
    "pane",
    "scrollPosition"
  ],
  "type": "object"
}

Scripting & web

Compiled & native

JVM

.NET

BEAM

tmux

`snapshot_pane`

Arguments#

Result#

Annotations#

Protocol data#