libtmux_mcp.tools.session_tools.rename_session

API reference · Markdown

libtmux_mcp.tools.session_tools.rename_session ( new_name : str , session_name : str | None = None , session_id : str | None = None , socket_name : str | None = None ) → SessionInfo

function [source] ¶

function [source] ¶

libtmux_mcp.tools.session_tools.rename_session

Rename a tmux session.

Use when a session's purpose has changed. Existing pane_id references remain valid after renaming.

Parameters

• new_name ( str ) – New name for the session.

• session_name ( str | None ) – Current session name to look up.

• session_id ( str | None ) – Session ID (e.g. '$1') to look up.

• socket_name ( str | None ) – tmux socket name. Defaults to LIBTMUX_SOCKET env var.

Returns

SessionInfo Serialized session object.