tool MCPlatest

`rename_session`

rename_session( name: string, session: string, )

tool [source]¶

Change tmux state; no client-supplied executable input. Rename a session. Its id does not change, so targets by id keep working.

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

Arguments#

name (string) #

The session’s new name.
session (string) #

Session id ($1) or name.

Result#

Returns object

session (object) #
- attachedClients (integer) #
  
  Raw client count from tmux; 0 means detached. Includes control-mode clients - this server’s own wait_for_text or other live read holds one open while it runs, and another program on this socket may hold others. See humanAttachedClients for a person-only count.
  
  minimum
  -9007199254740991
  maximum
  9007199254740991
- humanAttachedClients (integer) #
  
  attachedClients minus every control-mode client, this server’s own included.
  
  minimum
  -9007199254740991
  maximum
  9007199254740991
- id (string) #
  
  Stable session id, e.g. $1.
  
  pattern
  "^\\$\\d+$"
- metadataComplete (boolean) #
  
  Whether the session name is complete.
- name (string) #
- omittedMetadataBytes (integer) #
  
  UTF-8 bytes omitted from the session name.
  
  minimum
  0
  maximum
  9007199254740991
- windows (integer) #
  
  How many windows it holds.
  
  minimum
  -9007199254740991
  maximum
  9007199254740991
No other properties are accepted.

No other properties are accepted.

Annotations#

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

Protocol data#

Use the complete advertised contract for validation and client integration.

Input schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "name": {
      "description": "The session's new name.",
      "type": "string",
      "x-libtmux-tmux-format": "literalized-once"
    },
    "session": {
      "description": "Session id ($1) or name.",
      "type": "string"
    }
  },
  "required": [
    "name",
    "session"
  ],
  "type": "object"
}

Output schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "additionalProperties": false,
  "properties": {
    "session": {
      "additionalProperties": false,
      "properties": {
        "attachedClients": {
          "description": "Raw client count from tmux; 0 means detached. Includes control-mode clients - this server's own wait_for_text or other live read holds one open while it runs, and another program on this socket may hold others. See humanAttachedClients for a person-only count.",
          "maximum": 9007199254740991,
          "minimum": -9007199254740991,
          "type": "integer"
        },
        "humanAttachedClients": {
          "description": "attachedClients minus every control-mode client, this server's own included.",
          "maximum": 9007199254740991,
          "minimum": -9007199254740991,
          "type": "integer"
        },
        "id": {
          "description": "Stable session id, e.g. $1.",
          "pattern": "^\\$\\d+$",
          "type": "string"
        },
        "metadataComplete": {
          "description": "Whether the session name is complete.",
          "type": "boolean"
        },
        "name": {
          "type": "string"
        },
        "omittedMetadataBytes": {
          "description": "UTF-8 bytes omitted from the session name.",
          "maximum": 9007199254740991,
          "minimum": 0,
          "type": "integer"
        },
        "windows": {
          "description": "How many windows it holds.",
          "maximum": 9007199254740991,
          "minimum": -9007199254740991,
          "type": "integer"
        }
      },
      "required": [
        "attachedClients",
        "humanAttachedClients",
        "id",
        "metadataComplete",
        "name",
        "omittedMetadataBytes",
        "windows"
      ],
      "type": "object"
    }
  },
  "required": [
    "session"
  ],
  "type": "object"
}

Scripting & web

Compiled & native

JVM

.NET

BEAM

tmux

`rename_session`

Arguments#

Result#

Annotations#

Protocol data#