MCPAPI Reference

Choose documentation 3

latest

Current version

English

Prerelease This site documents an alpha of libtmux. Its structure, URLs and APIs are subject to change.

.mobile-toolbar, .documentation-context-navigation, #mobile-sidebar, #mobile-toc { display: none !important; }

Browse documentation

MCPAPI Reference

On this page

rename_session

Replaces a session’s name. Change tmux state; no client-supplied executable input.

All Java tools · JSON · Source

Arguments

new_name required · string: The literal new session name.
session_id required · string: The session ID, such as $1.

Schemas

The schema defines required fields, nested values, defaults, and validation constraints.

Input schema

{
  "additionalProperties": false,
  "properties": {
    "new_name": {
      "description": "The literal new session name.",
      "type": "string"
    },
    "session_id": {
      "description": "The session ID, such as $1.",
      "type": "string"
    }
  },
  "required": [
    "session_id",
    "new_name"
  ],
  "type": "object"
}

Output schema

{
  "additionalProperties": false,
  "properties": {
    "attached": {
      "type": "boolean"
    },
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "windows": {
      "type": "integer"
    }
  },
  "required": [
    "id",
    "name",
    "attached",
    "windows"
  ],
  "type": "object"
}

Tool annotations

{
  "destructiveHint": true,
  "idempotentHint": false,
  "openWorldHint": true,
  "readOnlyHint": false,
  "title": "Rename a session"
}