MCPpre-alphaAPI Reference

Choose documentation 3

stable

Current version

stable
English

Prerelease This site documents an alpha of libtmux. Its structure, URLs and APIs are subject to change.

libtmux_mcp.models.PaneInfo

class libtmux_mcp.models.PaneInfo
Bases:
  • BaseModel

Serialized tmux pane.

Members

pane_id : str = Field(description="Pane ID (e.g. '%1')")
pane_index : str | None = Field(default=None, description="Pane index")
pane_width : str | None = Field(default=None, description="Width in columns")
pane_height : str | None = Field(default=None, description="Height in rows")
pane_left : int | None = Field( default=None, description="Left edge column, 0-based and window-relative.", )
pane_top : int | None = Field( default=None, description="Top edge row, 0-based and window-relative.", )
pane_right : int | None = Field( default=None, description="Right edge column (inclusive), window-relative.", )
pane_bottom : int | None = Field( default=None, description="Bottom edge row (inclusive), window-relative.", )
pane_at_left : bool | None = Field( default=None, description="True when the pane touches the window's left edge.", )
pane_at_right : bool | None = Field( default=None, description="True when the pane touches the window's right edge.", )
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, so the top row " "may be 1 instead of 0 when the status bar is at the top." ), )
pane_at_bottom : bool | None = Field( default=None, description="True when the pane touches the window's bottom edge.", )
pane_tty : str | None = Field( default=None, description="TTY device path of the pane (e.g. '/dev/pts/5').", )
pane_current_command : str | None = Field( default=None, description="Running command" )
pane_current_path : str | None = Field( default=None, description="Current working directory" )
pane_pid : str | None = Field(default=None, description="Process ID")
pane_title : str | None = Field(default=None, description="Pane title")
pane_active : str | None = Field( default=None, description="Active flag ('1' or '0')" )
window_id : str | None = Field(default=None, description="Parent window ID")
session_id : str | None = Field(default=None, description="Parent session ID")
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." ), )
Esc

Type to search.

Reference preview Open reference