Models

Pydantic models for MCP tool inputs and outputs.

class libtmux_mcp.models.SessionInfo
class[source]
class[source]
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
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[source]
class[source]
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
active_pane_id: str | None
attribute
attribute
active_pane_id: str | None
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[source]
class[source]
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
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[source]
class[source]
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
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[source]
class[source]
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
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[source]
class[source]
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
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[source]
class[source]
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
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[source]
class[source]
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]
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[source]
class[source]
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
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[source]
class[source]
class libtmux_mcp.models.WaitForTextResult

Bases: BaseModel

Result of a bounded wait for new pane output.

Deliberately free of inference. Every field is something the tool observed directly — a match, a clock reading, a tmux flag. There is no “likely cause”, no “next action”, no quiescence verdict: a confidently-wrong diagnosis costs the agent more than an honest “nothing appeared, here is what the pane shows”.

Field count is load-bearing. outputSchema is re-sent on every request of every session, so a field that no agent branches on is a permanent tax. outcome carries what three separate booleans carried before it.

found: bool
attribute
attribute
found: bool
outcome: t.Literal['matched', 'any_output', 'stopped', 'alternate_screen', 'timeout']
attribute
attribute
outcome: t.Literal['matched', 'any_output', 'stopped', 'alternate_screen', 'timeout']
matched_index: int | None
attribute
attribute
matched_index: int | None
matched_lines: list[str]
attribute
attribute
matched_lines: list[str]
tail: list[str]
attribute
attribute
tail: list[str]
saw_new_output: bool
attribute
attribute
saw_new_output: bool
matched_at_entry: bool
attribute
attribute
matched_at_entry: bool
alternate_screen: bool
attribute
attribute
alternate_screen: bool
pane_id: str
attribute
attribute
pane_id: str
elapsed_seconds: float
attribute
attribute
elapsed_seconds: float
effective_timeout: float
attribute
attribute
effective_timeout: float
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.CaptureSinceResult
class[source]
class[source]
class libtmux_mcp.models.CaptureSinceResult

Bases: BaseModel

Incremental pane capture result with an opaque resume cursor.

pane_id: str
attribute
attribute
pane_id: str
cursor: str
attribute
attribute
cursor: str
lines: list[str]
attribute
attribute
lines: list[str]
elapsed_seconds: float
attribute
attribute
elapsed_seconds: float
lines_missed: bool
attribute
attribute
lines_missed: bool
truncated: bool
attribute
attribute
truncated: bool
truncated_lines: int
attribute
attribute
truncated_lines: int
truncated_bytes: int
attribute
attribute
truncated_bytes: int
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.RunCommandResult
class[source]
class[source]
class libtmux_mcp.models.RunCommandResult

Bases: BaseModel

Result of running a shell command in a pane.

pane_id: str
attribute
attribute
pane_id: str
exit_status: int | None
attribute
attribute
exit_status: int | None
timed_out: bool
attribute
attribute
timed_out: bool
elapsed_seconds: float
attribute
attribute
elapsed_seconds: float
output: list[str]
attribute
attribute
output: list[str]
output_truncated: bool
attribute
attribute
output_truncated: bool
output_truncated_lines: int
attribute
attribute
output_truncated_lines: int
effective_timeout: float
attribute
attribute
effective_timeout: float
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.SendKeysOperation
class[source]
class[source]
class libtmux_mcp.models.SendKeysOperation

Bases: BaseModel

One raw-input operation for batch sending.

Used by send_keys_batch().

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}
attribute
attribute
model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

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

keys: str
attribute
attribute
keys: str
pane_id: str | None
attribute
attribute
pane_id: str | None
session_name: str | None
attribute
attribute
session_name: str | None
session_id: str | None
attribute
attribute
session_id: str | None
window_id: str | None
attribute
attribute
window_id: str | None
enter: bool
attribute
attribute
enter: bool
literal: bool
attribute
attribute
literal: bool
suppress_history: bool
attribute
attribute
suppress_history: bool
class libtmux_mcp.models.SendKeysOperationResult
class[source]
class[source]
class libtmux_mcp.models.SendKeysOperationResult

Bases: BaseModel

Per-operation result from batch sending.

Returned by send_keys_batch().

index: int
attribute
attribute
index: int
pane_id: str | None
attribute
attribute
pane_id: str | None
success: bool
attribute
attribute
success: bool
error: str | None
attribute
attribute
error: str | None
elapsed_seconds: float
attribute
attribute
elapsed_seconds: float
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.SendKeysBatchResult
class[source]
class[source]
class libtmux_mcp.models.SendKeysBatchResult

Bases: BaseModel

Structured result for a batch of raw-input send operations.

results: list[SendKeysOperationResult]
attribute
attribute
results: list[SendKeysOperationResult]
succeeded: int
attribute
attribute
succeeded: int
failed: int
attribute
attribute
failed: int
stopped_at: int | None
attribute
attribute
stopped_at: int | None
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.ToolCallOperation
class[source]
class[source]
class libtmux_mcp.models.ToolCallOperation

Bases: BaseModel

One nested MCP tool call for a batch wrapper.

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}
attribute
attribute
model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

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

tool: str
attribute
attribute
tool: str
arguments: dict[str, t.Any]
attribute
attribute
arguments: dict[str, t.Any]
class libtmux_mcp.models.ToolCallOperationResult
class[source]
class[source]
class libtmux_mcp.models.ToolCallOperationResult

Bases: BaseModel

Per-operation result from a generic MCP tool batch.

index: int
attribute
attribute
index: int
tool: str
attribute
attribute
tool: str
success: bool
attribute
attribute
success: bool
error: str | None
attribute
attribute
error: str | None
content: list[dict[str, t.Any]]
attribute
attribute
content: list[dict[str, t.Any]]
structured_content: dict[str, t.Any] | None
attribute
attribute
structured_content: dict[str, t.Any] | None
meta: dict[str, t.Any] | None
attribute
attribute
meta: dict[str, t.Any] | None
elapsed_seconds: float
attribute
attribute
elapsed_seconds: float
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.ToolCallBatchResult
class[source]
class[source]
class libtmux_mcp.models.ToolCallBatchResult

Bases: BaseModel

Structured result for a serial batch of MCP tool calls.

results: list[ToolCallOperationResult]
attribute
attribute
results: list[ToolCallOperationResult]
succeeded: int
attribute
attribute
succeeded: int
failed: int
attribute
attribute
failed: int
stopped_at: int | None
attribute
attribute
stopped_at: int | None
response_truncated: bool
attribute
attribute
response_truncated: bool
response_truncated_bytes: int
attribute
attribute
response_truncated_bytes: int
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[source]
class[source]
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_pid: str | None
attribute
attribute
pane_pid: str | None
pane_dead: bool | None
attribute
attribute
pane_dead: bool | None
alternate_on: bool | None
attribute
attribute
alternate_on: bool | 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
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[source]
class[source]
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 of PaneContentMatch rows 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
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[source]
class[source]
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
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[source]
class[source]
class libtmux_mcp.models.HookListResult

Bases: BaseModel

Structured result for hook introspection.

Returned by show_hooks() and 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]
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[source]
class[source]
class libtmux_mcp.models.BufferRef

Bases: BaseModel

Handle returned by load_buffer().

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(), and delete_buffer() calls.

buffer_name: str
attribute
attribute
buffer_name: str
logical_name: str | None
attribute
attribute
logical_name: str | None
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[source]
class[source]
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
model_config: ClassVar[ConfigDict] = {}
attribute
attribute
model_config: ClassVar[ConfigDict] = {}

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