Snapshot pane

snapshot_pane

snapshot_pane

readonly tool

Take a rich snapshot of a tmux pane: content + cursor + mode + scroll state.

Returns:

PaneSnapshot

Use when you need a complete picture of a pane in a single call — visible text plus cursor position, whether the pane is in copy mode, scroll offset, and scrollback history size. Replaces separate capture_pane + get_pane_info calls when you need to reason about cursor location or terminal mode.

Avoid when you only need raw text — capture_pane is lighter.

Side effects: None. Readonly.

Example:

{
  "tool": "snapshot_pane",
  "arguments": {
    "pane_id": "%0"
  }
}

Response:

{
  "pane_id": "%0",
  "content": "$ npm test\n\nPASS src/auth.test.ts\nTests: 3 passed\n$",
  "cursor_x": 2,
  "cursor_y": 4,
  "pane_width": 80,
  "pane_height": 24,
  "pane_in_mode": false,
  "pane_mode": null,
  "scroll_position": null,
  "history_size": 142,
  "title": null,
  "pane_current_command": "zsh",
  "pane_current_path": "/home/user/myproject",
  "is_caller": false
}

Parameters

Parameter	Type	Required	Default	Description
pane_id	str	no	—	Pane ID (e.g. ‘%1’).
session_name	str	no	—	Session name for pane resolution.
session_id	str	no	—	Session ID (e.g. ‘$1’) for pane resolution.
window_id	str	no	—	Window ID for pane resolution.
max_lines	int	no	500	Maximum number of content lines to return. Defaults to :data:libtmux_mcp.tools.pane_tools.io.CAPTURE_DEFAULT_MAX_LINES. Pass None to return the full capture untrimmed.
socket_name	str	no	—	tmux socket name.