libtmux_mcp.models.PaneSnapshot

Python

Python
Ruby Unavailable
Lua Unavailable
TypeScript Unavailable
Rust Unavailable
Go Unavailable
Java Unavailable
.NET Unavailable
C++ Unavailable
Swift Unavailable

API reference · Markdown

class libtmux_mcp.models.PaneSnapshot class [source] ¶ class [source] ¶ class libtmux_mcp.models.PaneSnapshot

Bases:

BaseModel

Rich screen capture with metadata: content, cursor, mode, and scroll state.

Members

pane_id

pane_id : str = Field(description="Pane ID (e.g. '%1')") attribute [source] ¶ attribute [source] ¶ pane_id

content

content : str = Field(description="Visible pane text") attribute [source] ¶ attribute [source] ¶ content

cursor_x

cursor_x : int = Field(description="Cursor column (0-based)") attribute [source] ¶ attribute [source] ¶ cursor_x

cursor_y

cursor_y : int = Field(description="Cursor row (0-based)") attribute [source] ¶ attribute [source] ¶ cursor_y

pane_width

pane_width : int = Field(description="Pane width in columns") attribute [source] ¶ attribute [source] ¶ pane_width

pane_height

pane_height : int = Field(description="Pane height in rows") attribute [source] ¶ attribute [source] ¶ pane_height

pane_left

pane_left : int | None = Field( default=None, description="Left edge column, 0-based and window-relative.", ) attribute [source] ¶ attribute [source] ¶ pane_left

pane_top

pane_top : int | None = Field( default=None, description="Top edge row, 0-based and window-relative.", ) attribute [source] ¶ attribute [source] ¶ pane_top

pane_right

pane_right : int | None = Field( default=None, description="Right edge column (inclusive), window-relative.", ) attribute [source] ¶ attribute [source] ¶ pane_right

pane_bottom

pane_bottom : int | None = Field( default=None, description="Bottom edge row (inclusive), window-relative.", ) attribute [source] ¶ attribute [source] ¶ pane_bottom

pane_at_left

pane_at_left : bool | None = Field( default=None, description="True when the pane touches the window's left edge.", ) attribute [source] ¶ attribute [source] ¶ pane_at_left

pane_at_right

pane_at_right : bool | None = Field( default=None, description="True when the pane touches the window's right edge.", ) attribute [source] ¶ attribute [source] ¶ pane_at_right

pane_at_top

pane_at_top : bool | None = Field( default=None, description=( "True when the pane touches the window's top edge. tmux " "accounts for ``pane-border-status`` here." ), ) attribute [source] ¶ attribute [source] ¶ pane_at_top

pane_at_bottom

pane_at_bottom : bool | None = Field( default=None, description="True when the pane touches the window's bottom edge.", ) attribute [source] ¶ attribute [source] ¶ pane_at_bottom

pane_tty

pane_tty : str | None = Field( default=None, description="TTY device path of the pane (e.g. '/dev/pts/5').", ) attribute [source] ¶ attribute [source] ¶ pane_tty

pane_pid

pane_pid : str | None = Field(default=None, description="Process ID") attribute [source] ¶ attribute [source] ¶ pane_pid

pane_dead

pane_dead : bool | None = Field( default=None, description="True when tmux reports the pane process has exited.", ) attribute [source] ¶ attribute [source] ¶ pane_dead

alternate_on

alternate_on : bool | None = Field( default=None, description="True when the pane is using the alternate screen.", ) attribute [source] ¶ attribute [source] ¶ alternate_on

pane_in_mode

pane_in_mode : bool = Field(description="True if pane is in copy-mode or view-mode") attribute [source] ¶ attribute [source] ¶ pane_in_mode

pane_mode

pane_mode : str | None = Field( default=None, description="Mode name (e.g. 'copy-mode') or None if normal" ) attribute [source] ¶ attribute [source] ¶ pane_mode

scroll_position

scroll_position : int | None = Field( default=None, description="Lines scrolled back in copy mode (None if not in copy mode)", ) attribute [source] ¶ attribute [source] ¶ scroll_position

history_size

history_size : int = Field(description="Total scrollback lines available") attribute [source] ¶ attribute [source] ¶ history_size

title

title : str | None = Field(default=None, description="Pane title") attribute [source] ¶ attribute [source] ¶ title

pane_current_command

pane_current_command : str | None = Field( default=None, description="Running command" ) attribute [source] ¶ attribute [source] ¶ pane_current_command

pane_current_path

pane_current_path : str | None = Field( default=None, description="Current working directory" ) attribute [source] ¶ attribute [source] ¶ pane_current_path

is_caller

is_caller : bool | None = Field( default=None, description=( "MCP caller identity for this pane. ``True`` when the pane " "matches the caller's ``TMUX_PANE`` *and* lives on the same " "tmux socket as the caller's ``TMUX`` (verified via socket " "realpath); ``False`` otherwise, including the case where " "the pane id matches but the socket does not or cannot be " "proven to; ``None`` when the MCP process is not running " "inside tmux at all." ), ) attribute [source] ¶ attribute [source] ¶ is_caller

content_truncated

content_truncated : bool = Field( default=False, description=( "True if ``content`` was tail-preserved to stay within " "``max_lines``; oldest lines were dropped." ), ) attribute [source] ¶ attribute [source] ¶ content_truncated

content_truncated_lines

content_truncated_lines : int = Field( default=0, description="Number of lines dropped from the head when truncating.", ) attribute [source] ¶ attribute [source] ¶ content_truncated_lines