libtmux_mcp.tools.pane_tools.clear_pane

API reference · Markdown

libtmux_mcp.tools.pane_tools.clear_pane ( pane_id : str | None = None , session_name : str | None = None , session_id : str | None = None , window_id : str | None = None , socket_name : str | None = None ) → str

function [source] ¶

function [source] ¶

libtmux_mcp.tools.pane_tools.clear_pane

Clear the contents of a tmux pane.

Use before a fresh run_command call or raw-input observation workflow when prior scrollback would make the result harder to inspect.

Parameters

• pane_id ( str | None ) – Pane ID (e.g. '%1').

• session_name ( str | None ) – Session name for pane resolution.

• session_id ( str | None ) – Session ID (e.g. '$1') for pane resolution.

• window_id ( str | None ) – Window ID for pane resolution.

• socket_name ( str | None ) – tmux socket name.

Returns

str Confirmation message.