rename_session
- rename_session( new_name: string, session_id?: string | null, session_name?: string | null, socket_name?: string | null, )
-
Rename a tmux session.
Use when a session’s purpose has changed. Existing pane_id references remain valid after renaming.
- MCP request method
tools/callSendrename_sessionas the tool name, with the arguments below.
Arguments#
-
New name for the session.
-
session_id? =null(string | null) #Session ID (e.g. ‘$1’) to look up.
-
session_name? =null(string | null) #Current session name to look up.
-
socket_name? =null(string | null) #tmux socket name. Defaults to LIBTMUX_SOCKET env var.
No other arguments are accepted.
Result#
Returns object
-
active_pane_id? =null(string | null) #Pane id (
%N) of the session’s active pane. Guaranteed non-None oncreate_sessionreturn (libtmux creates the session with one initial pane). May be None fromlist_sessionsrows for sessions in transient teardown states whereactive_paneis unavailable. -
session_attached? =null(string | null) #Attached client count
-
session_created? =null(string | null) #Creation timestamp
-
Session ID (e.g. ‘$1’)
-
session_name? =null(string | null) #Session name
-
Number of windows
Annotations#
destructiveHinttrueidempotentHintfalseopenWorldHinttruereadOnlyHintfalse
Protocol data#
Use the complete advertised contract for validation and client integration.
Input schema
{"additionalProperties": false,"properties": {"new_name": {"description": "New name for the session.","type": "string"},"session_id": {"anyOf": [{"type": "string"},{"type": "null"}],"default": null,"description": "Session ID (e.g. '$1') to look up."},"session_name": {"anyOf": [{"type": "string"},{"type": "null"}],"default": null,"description": "Current session name to look up."},"socket_name": {"anyOf": [{"type": "string"},{"type": "null"}],"default": null,"description": "tmux socket name. Defaults to LIBTMUX_SOCKET env var."}},"required": ["new_name"],"type": "object"}Output schema
{"description": "Serialized tmux session.","properties": {"active_pane_id": {"anyOf": [{"type": "string"},{"type": "null"}],"default": null,"description": "Pane id (``%N``) of the session's active pane. Guaranteed non-None on ``create_session`` return (libtmux creates the session with one initial pane). May be None from ``list_sessions`` rows for sessions in transient teardown states where ``active_pane`` is unavailable."},"session_attached": {"anyOf": [{"type": "string"},{"type": "null"}],"default": null,"description": "Attached client count"},"session_created": {"anyOf": [{"type": "string"},{"type": "null"}],"default": null,"description": "Creation timestamp"},"session_id": {"description": "Session ID (e.g. '$1')","type": "string"},"session_name": {"anyOf": [{"type": "string"},{"type": "null"}],"default": null,"description": "Session name"},"window_count": {"description": "Number of windows","type": "integer"}},"required": ["session_id","window_count"],"type": "object"}