# snapshot_pane

Source: https://libtmux.org/en/ts/latest/mcp/tools/snapshot_pane/

> 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 is in development

Server behavior and tool contracts may change. Tool availability depends on the server configuration.

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.

[All TypeScript tools](https://libtmux.org/en/ts/latest/mcp/tools/) · [JSON](https://libtmux.org/en/ts/latest/mcp/tools/snapshot_pane.json) · [Source](https://github.com/libtmux/libtmux-ts/blob/b3f338c1a21e614ebf0dd6d55aa36a60db816618/packages/mcp/src/tools/target.ts#L305)

## Arguments

* `maxLines` optional · integer

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

* `paneId` required · string

  Stable pane id, e.g. %1.

## Schemas

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

Input schema

```json
{
  "$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

```json
{
  "$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"
}
```

Tool annotations

```json
{
  "destructiveHint": true,
  "idempotentHint": false,
  "openWorldHint": true,
  "readOnlyHint": false
}
```