# snapshot_pane

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

> Read pane output; accepts no client-supplied executable input. Returned content may be sensitive or untrusted. Returns pane metadata and bounded terminal content together.

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. Returns pane metadata and bounded terminal content together.

[All Go tools](https://libtmux.org/en/go/latest/mcp/tools/) · [JSON](https://libtmux.org/en/go/latest/mcp/tools/snapshot_pane.json) · [Source](https://github.com/libtmux/libtmux-go/blob/aaf86678fe0cbdf56f9e1c9c46b0db0704e15656/mcp/manifest_catalog.go#L210)

## Arguments

* `history` optional · boolean

  include scrollback as well as the visible screen

* `max_lines` optional · integer

  maximum lines, keeping the newest

* `pane_id` required · string

  the pane id, such as %1

## Schemas

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

Input schema

```json
{
  "additionalProperties": false,
  "properties": {
    "history": {
      "description": "include scrollback as well as the visible screen",
      "type": "boolean"
    },
    "max_lines": {
      "description": "maximum lines, keeping the newest",
      "type": "integer"
    },
    "pane_id": {
      "description": "the pane id, such as %1",
      "type": "string"
    }
  },
  "required": [
    "pane_id"
  ],
  "type": "object"
}
```

Output schema

```json
{
  "additionalProperties": false,
  "properties": {
    "dead": {
      "type": "boolean"
    },
    "exitStatus": {
      "type": [
        "null",
        "integer"
      ]
    },
    "lines": {
      "items": {
        "type": "string"
      },
      "type": [
        "array"
      ]
    },
    "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"
    },
    "truncated": {
      "type": "boolean"
    },
    "truncatedBytes": {
      "type": "integer"
    },
    "truncatedLines": {
      "type": "integer"
    }
  },
  "required": [
    "lines",
    "pane",
    "dead",
    "truncated"
  ],
  "type": "object"
}
```

Tool annotations

```json
{
  "destructiveHint": true,
  "openWorldHint": true,
  "title": "Snapshot a pane"
}
```