libtmux_mcp.tools.window_tools.rename_window

API reference · Markdown

libtmux_mcp.tools.window_tools.rename_window ( new_name : str , window_id : str | None = None , window_index : str | None = None , session_name : str | None = None , session_id : str | None = None , socket_name : str | None = None ) → WindowInfo

function [source] ¶

function [source] ¶

libtmux_mcp.tools.window_tools.rename_window

Rename a tmux window.

Use when a window's purpose has changed. Existing window_id references remain valid after renaming.

Parameters

• new_name ( str ) – The new name for the window.

• window_id ( str | None ) – Window ID (e.g. '@1').

• window_index ( str | None ) – Window index within the session.

• session_name ( str | None ) – Session name.

• session_id ( str | None ) – Session ID.

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

Returns

WindowInfo Serialized window object.