Python MCP reference

tool MCPstable

`rename_window`

Rename a tmux window.

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

MCP request method: tools/call Send rename_window as the tool name, with the arguments below.

Arguments#

new_name (string) #

The new name for the window.
session_id? = null (string | null) #

Session ID.
session_name? = null (string | null) #

Session name.
socket_name? = null (string | null) #

tmux socket name.
window_id? = null (string | null) #

Window ID (e.g. ‘@1’).
window_index? = null (string | null) #

Window index within the session.

No other arguments are accepted.

Result#

Returns object

active_pane_id? = null (string | null) #

Pane id (%N) of the window’s active pane.
pane_count (integer) #

Number of panes
session_id? = null (string | null) #

Parent session ID
session_name? = null (string | null) #

Parent session name
window_active? = null (string | null) #

Active flag (‘1’ or ‘0’)
window_height? = null (string | null) #

Height in rows
window_id (string) #

Window ID (e.g. ‘@1’)
window_index? = null (string | null) #

Window index
window_layout? = null (string | null) #

Layout string
window_name? = null (string | null) #

Window name
window_width? = null (string | null) #

Width in columns

Annotations#

destructiveHint: true
idempotentHint: false
openWorldHint: true
readOnlyHint: false

Protocol data#

Use the complete advertised contract for validation and client integration.

Input schema

{
  "additionalProperties": false,
  "properties": {
    "new_name": {
      "description": "The new name for the window.",
      "type": "string"
    },
    "session_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Session ID."
    },
    "session_name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Session name."
    },
    "socket_name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "tmux socket name."
    },
    "window_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Window ID (e.g. '@1')."
    },
    "window_index": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Window index within the session."
    }
  },
  "required": [
    "new_name"
  ],
  "type": "object"
}

Output schema

{
  "description": "Serialized tmux window.",
  "properties": {
    "active_pane_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Pane id (``%N``) of the window's active pane."
    },
    "pane_count": {
      "description": "Number of panes",
      "type": "integer"
    },
    "session_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Parent session ID"
    },
    "session_name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Parent session name"
    },
    "window_active": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Active flag ('1' or '0')"
    },
    "window_height": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Height in rows"
    },
    "window_id": {
      "description": "Window ID (e.g. '@1')",
      "type": "string"
    },
    "window_index": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Window index"
    },
    "window_layout": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Layout string"
    },
    "window_name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Window name"
    },
    "window_width": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Width in columns"
    }
  },
  "required": [
    "window_id",
    "pane_count"
  ],
  "type": "object"
}

Scripting & web

Compiled & native

JVM

.NET

tmux

`rename_window`

Arguments#

Result#

Annotations#

Protocol data#