Models

Pydantic models for MCP tool inputs and outputs.

class libtmux_mcp.models.SessionInfo

class

class

class libtmux_mcp.models.SessionInfo

Bases: BaseModel

Serialized tmux session.

session_id: str

attribute

attribute

session_id: str

session_name: str | None

attribute

attribute

session_name: str | None

window_count: int

attribute

attribute

window_count: int

session_attached: str | None

attribute

attribute

session_attached: str | None

session_created: str | None

attribute

attribute

session_created: str | None

active_pane_id: str | None

attribute

attribute

active_pane_id: str | None

_abc_impl = <_abc._abc_data object>

attribute

attribute

_abc_impl = <_abc._abc_data object>

model_config: ClassVar[ConfigDict] = {}

attribute

attribute

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to ConfigDict.

class libtmux_mcp.models.WindowInfo

class

class

class libtmux_mcp.models.WindowInfo

Bases: BaseModel

Serialized tmux window.

window_id: str

attribute

attribute

window_id: str

window_name: str | None

attribute

attribute

window_name: str | None

window_index: str | None

attribute

attribute

window_index: str | None

session_id: str | None

attribute

attribute

session_id: str | None

session_name: str | None

attribute

attribute

session_name: str | None

pane_count: int

attribute

attribute

pane_count: int

window_layout: str | None

attribute

attribute

window_layout: str | None

window_active: str | None

attribute

attribute

window_active: str | None

window_width: str | None

attribute

attribute

window_width: str | None

window_height: str | None

attribute

attribute

window_height: str | None

_abc_impl = <_abc._abc_data object>

attribute

attribute

_abc_impl = <_abc._abc_data object>

model_config: ClassVar[ConfigDict] = {}

attribute

attribute

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to ConfigDict.

class libtmux_mcp.models.PaneInfo

class

class

class libtmux_mcp.models.PaneInfo

Bases: BaseModel

Serialized tmux pane.

pane_id: str

attribute

attribute

pane_id: str

pane_index: str | None

attribute

attribute

pane_index: str | None

pane_width: str | None

attribute

attribute

pane_width: str | None

pane_height: str | None

attribute

attribute

pane_height: str | None

pane_left: int | None

attribute

attribute

pane_left: int | None

pane_top: int | None

attribute

attribute

pane_top: int | None

pane_right: int | None

attribute

attribute

pane_right: int | None

pane_bottom: int | None

attribute

attribute

pane_bottom: int | None

pane_at_left: bool | None

attribute

attribute

pane_at_left: bool | None

pane_at_right: bool | None

attribute

attribute

pane_at_right: bool | None

pane_at_top: bool | None

attribute

attribute

pane_at_top: bool | None

pane_at_bottom: bool | None

attribute

attribute

pane_at_bottom: bool | None

pane_tty: str | None

attribute

attribute

pane_tty: str | None

pane_current_command: str | None

attribute

attribute

pane_current_command: str | None

pane_current_path: str | None

attribute

attribute

pane_current_path: str | None

pane_pid: str | None

attribute

attribute

pane_pid: str | None

pane_title: str | None

attribute

attribute

pane_title: str | None

pane_active: str | None

attribute

attribute

pane_active: str | None

window_id: str | None

attribute

attribute

window_id: str | None

session_id: str | None

attribute

attribute

session_id: str | None

is_caller: bool | None

attribute

attribute

is_caller: bool | None

_abc_impl = <_abc._abc_data object>

attribute

attribute

_abc_impl = <_abc._abc_data object>

model_config: ClassVar[ConfigDict] = {}

attribute

attribute

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to ConfigDict.

class libtmux_mcp.models.PaneContentMatch

class

class

class libtmux_mcp.models.PaneContentMatch

Bases: BaseModel

A pane whose captured content matched a search pattern.

pane_id: str

attribute

attribute

pane_id: str

pane_left: int | None

attribute

attribute

pane_left: int | None

pane_top: int | None

attribute

attribute

pane_top: int | None

pane_right: int | None

attribute

attribute

pane_right: int | None

pane_bottom: int | None

attribute

attribute

pane_bottom: int | None

pane_at_left: bool | None

attribute

attribute

pane_at_left: bool | None

pane_at_right: bool | None

attribute

attribute

pane_at_right: bool | None

pane_at_top: bool | None

attribute

attribute

pane_at_top: bool | None

pane_at_bottom: bool | None

attribute

attribute

pane_at_bottom: bool | None

pane_tty: str | None

attribute

attribute

pane_tty: str | None

pane_current_command: str | None

attribute

attribute

pane_current_command: str | None

pane_current_path: str | None

attribute

attribute

pane_current_path: str | None

window_id: str | None

attribute

attribute

window_id: str | None

window_name: str | None

attribute

attribute

window_name: str | None

session_id: str | None

attribute

attribute

session_id: str | None

session_name: str | None

attribute

attribute

session_name: str | None

matched_lines: list[str]

attribute

attribute

matched_lines: list[str]

is_caller: bool | None

attribute

attribute

is_caller: bool | None

_abc_impl = <_abc._abc_data object>

attribute

attribute

_abc_impl = <_abc._abc_data object>

model_config: ClassVar[ConfigDict] = {}

attribute

attribute

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to ConfigDict.

class libtmux_mcp.models.ServerInfo

class

class

class libtmux_mcp.models.ServerInfo

Bases: BaseModel

Serialized tmux server info.

is_alive: bool

attribute

attribute

is_alive: bool

socket_name: str | None

attribute

attribute

socket_name: str | None

socket_path: str | None

attribute

attribute

socket_path: str | None

session_count: int

attribute

attribute

session_count: int

version: str | None

attribute

attribute

version: str | None

_abc_impl = <_abc._abc_data object>

attribute

attribute

_abc_impl = <_abc._abc_data object>

model_config: ClassVar[ConfigDict] = {}

attribute

attribute

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to ConfigDict.

class libtmux_mcp.models.OptionResult

class

class

class libtmux_mcp.models.OptionResult

Bases: BaseModel

Result of a show_option call.

option: str

attribute

attribute

option: str

value: t.Any

attribute

attribute

value: t.Any

_abc_impl = <_abc._abc_data object>

attribute

attribute

_abc_impl = <_abc._abc_data object>

model_config: ClassVar[ConfigDict] = {}

attribute

attribute

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to ConfigDict.

class libtmux_mcp.models.OptionSetResult

class

class

class libtmux_mcp.models.OptionSetResult

Bases: BaseModel

Result of a set_option call.

option: str

attribute

attribute

option: str

value: str

attribute

attribute

value: str

status: str

attribute

attribute

status: str

_abc_impl = <_abc._abc_data object>

attribute

attribute

_abc_impl = <_abc._abc_data object>

model_config: ClassVar[ConfigDict] = {}

attribute

attribute

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to ConfigDict.

class libtmux_mcp.models.EnvironmentResult

class

class

class libtmux_mcp.models.EnvironmentResult

Bases: BaseModel

Result of a show_environment call.

variables: dict[str, str | bool]

attribute

attribute

variables: dict[str, str | bool]

_abc_impl = <_abc._abc_data object>

attribute

attribute

_abc_impl = <_abc._abc_data object>

model_config: ClassVar[ConfigDict] = {}

attribute

attribute

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to ConfigDict.

class libtmux_mcp.models.EnvironmentSetResult

class

class

class libtmux_mcp.models.EnvironmentSetResult

Bases: BaseModel

Result of a set_environment call.

name: str

attribute

attribute

name: str

value: str

attribute

attribute

value: str

status: str

attribute

attribute

status: str

_abc_impl = <_abc._abc_data object>

attribute

attribute

_abc_impl = <_abc._abc_data object>

model_config: ClassVar[ConfigDict] = {}

attribute

attribute

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to ConfigDict.

class libtmux_mcp.models.WaitForTextResult

class

class

class libtmux_mcp.models.WaitForTextResult

Bases: BaseModel

Result of waiting for text to appear in a pane.

found: bool

attribute

attribute

found: bool

matched_lines: list[str]

attribute

attribute

matched_lines: list[str]

pane_id: str

attribute

attribute

pane_id: str

elapsed_seconds: float

attribute

attribute

elapsed_seconds: float

timed_out: bool

attribute

attribute

timed_out: bool

_abc_impl = <_abc._abc_data object>

attribute

attribute

_abc_impl = <_abc._abc_data object>

model_config: ClassVar[ConfigDict] = {}

attribute

attribute

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to ConfigDict.

class libtmux_mcp.models.PaneSnapshot

class

class

class libtmux_mcp.models.PaneSnapshot

Bases: BaseModel

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

pane_id: str

attribute

attribute

pane_id: str

content: str

attribute

attribute

content: str

cursor_x: int

attribute

attribute

cursor_x: int

cursor_y: int

attribute

attribute

cursor_y: int

pane_width: int

attribute

attribute

pane_width: int

pane_height: int

attribute

attribute

pane_height: int

pane_left: int | None

attribute

attribute

pane_left: int | None

pane_top: int | None

attribute

attribute

pane_top: int | None

pane_right: int | None

attribute

attribute

pane_right: int | None

pane_bottom: int | None

attribute

attribute

pane_bottom: int | None

pane_at_left: bool | None

attribute

attribute

pane_at_left: bool | None

pane_at_right: bool | None

attribute

attribute

pane_at_right: bool | None

pane_at_top: bool | None

attribute

attribute

pane_at_top: bool | None

pane_at_bottom: bool | None

attribute

attribute

pane_at_bottom: bool | None

pane_tty: str | None

attribute

attribute

pane_tty: str | None

pane_in_mode: bool

attribute

attribute

pane_in_mode: bool

pane_mode: str | None

attribute

attribute

pane_mode: str | None

scroll_position: int | None

attribute

attribute

scroll_position: int | None

history_size: int

attribute

attribute

history_size: int

title: str | None

attribute

attribute

title: str | None

pane_current_command: str | None

attribute

attribute

pane_current_command: str | None

pane_current_path: str | None

attribute

attribute

pane_current_path: str | None

is_caller: bool | None

attribute

attribute

is_caller: bool | None

content_truncated: bool

attribute

attribute

content_truncated: bool

content_truncated_lines: int

attribute

attribute

content_truncated_lines: int

_abc_impl = <_abc._abc_data object>

attribute

attribute

_abc_impl = <_abc._abc_data object>

model_config: ClassVar[ConfigDict] = {}

attribute

attribute

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to ConfigDict.

class libtmux_mcp.models.SearchPanesResult

class

class

class libtmux_mcp.models.SearchPanesResult

Bases: BaseModel

Paginated result of search_panes().

Wrapping the match list lets us surface bounded-output information that a bare list[PaneContentMatch] cannot: whether pagination truncated the result set, which panes were skipped, and the offset/limit that produced this page. Agents can re-request with a higher offset to retrieve subsequent pages.

matches: list[PaneContentMatch]

attribute

attribute

matches: list[PaneContentMatch]

truncated: bool

attribute

attribute

truncated: bool

truncated_panes: list[str]

attribute

attribute

truncated_panes: list[str]

total_panes_matched: int

attribute

attribute

total_panes_matched: int

offset: int

attribute

attribute

offset: int

limit: int | None

attribute

attribute

limit: int | None

_abc_impl = <_abc._abc_data object>

attribute

attribute

_abc_impl = <_abc._abc_data object>

model_config: ClassVar[ConfigDict] = {}

attribute

attribute

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to ConfigDict.

class libtmux_mcp.models.HookEntry

class

class

class libtmux_mcp.models.HookEntry

Bases: BaseModel

One entry in a tmux hook array.

Hooks like session-renamed are arrays — they can have multiple commands registered at sparse indices. HookEntry flattens one index+command pair into a serialisable row.

hook_name: str

attribute

attribute

hook_name: str

index: int | None

attribute

attribute

index: int | None

command: str

attribute

attribute

command: str

_abc_impl = <_abc._abc_data object>

attribute

attribute

_abc_impl = <_abc._abc_data object>

model_config: ClassVar[ConfigDict] = {}

attribute

attribute

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to ConfigDict.

class libtmux_mcp.models.HookListResult

class

class

class libtmux_mcp.models.HookListResult

Bases: BaseModel

Structured result of show_hooks() / show_hook().

Flat list of HookEntry instances so MCP clients can iterate without caring whether the underlying tmux hook is scalar or array- shaped.

entries: list[HookEntry]

attribute

attribute

entries: list[HookEntry]

_abc_impl = <_abc._abc_data object>

attribute

attribute

_abc_impl = <_abc._abc_data object>

model_config: ClassVar[ConfigDict] = {}

attribute

attribute

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to ConfigDict.

class libtmux_mcp.models.BufferRef

class

class

class libtmux_mcp.models.BufferRef

Bases: BaseModel

Handle returned by load_buffer() for later buffer operations.

Agent-created tmux paste buffers are namespaced with a per-call UUID to avoid collisions on the server-global buffer namespace when concurrent agents (or parallel tool calls from a single agent) are staging content. Callers must use the buffer_name this model carries on subsequent paste_buffer / show_buffer / delete_buffer calls.

buffer_name: str

attribute

attribute

buffer_name: str

logical_name: str | None

attribute

attribute

logical_name: str | None

_abc_impl = <_abc._abc_data object>

attribute

attribute

_abc_impl = <_abc._abc_data object>

model_config: ClassVar[ConfigDict] = {}

attribute

attribute

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to ConfigDict.

class libtmux_mcp.models.BufferContent

class

class

class libtmux_mcp.models.BufferContent

Bases: BaseModel

Structured result of show_buffer().

buffer_name: str

attribute

attribute

buffer_name: str

content: str

attribute

attribute

content: str

content_truncated: bool

attribute

attribute

content_truncated: bool

content_truncated_lines: int

attribute

attribute

content_truncated_lines: int

_abc_impl = <_abc._abc_data object>

attribute

attribute

_abc_impl = <_abc._abc_data object>

model_config: ClassVar[ConfigDict] = {}

attribute

attribute

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to ConfigDict.

class libtmux_mcp.models.ContentChangeResult

class

class

class libtmux_mcp.models.ContentChangeResult

Bases: BaseModel

Result of waiting for any screen content change.

changed: bool

attribute

attribute

changed: bool

pane_id: str

attribute

attribute

pane_id: str

elapsed_seconds: float

attribute

attribute

elapsed_seconds: float

timed_out: bool

attribute

attribute

timed_out: bool

_abc_impl = <_abc._abc_data object>

attribute

attribute

_abc_impl = <_abc._abc_data object>

model_config: ClassVar[ConfigDict] = {}

attribute

attribute

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to ConfigDict.