`libtmux_mcp.models.PaneSnapshot`

class libtmux_mcp.models.PaneSnapshot class [source] ¶

Bases:

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

Members

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

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

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

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

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

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

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

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

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

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

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

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] ¶

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

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

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

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

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

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

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

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

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

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

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

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

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] ¶

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

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