# rename_session

Source: https://libtmux.org/en/rs/latest/mcp/tools/rename_session/

> Rename one session. Change tmux state; no client-supplied executable input.

MCP is in development

Server behavior and tool contracts may change. Tool availability depends on the server configuration.

Rename one session. Change tmux state; no client-supplied executable input.

[All Rust tools](https://libtmux.org/en/rs/latest/mcp/tools/) · [JSON](https://libtmux.org/en/rs/latest/mcp/tools/rename_session.json) · [Source](https://github.com/libtmux/libtmux-rs/blob/2cef1aa642182dd1970c3688feb6a568ff666e64/crates/tmux-mcp/src/tools/contract.rs#L713)

## Arguments

* `name` required · string

  The new name. tmux refuses one another session has.

* `session` required · string

  The session to rename, by \`$\`-prefixed id or name.

## Schemas

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

Input schema

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "The new name. tmux refuses one another session has.",
      "type": "string"
    },
    "session": {
      "description": "The session to rename, by `$`-prefixed id or name.",
      "type": "string"
    }
  },
  "required": [
    "session",
    "name"
  ],
  "type": "object"
}
```

Output schema

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "attached": {
      "description": "Whether any client is attached.",
      "type": "boolean"
    },
    "id": {
      "description": "The `$`-prefixed tmux identity.",
      "type": "string"
    },
    "name": {
      "description": "The session name, absent when tmux reported none.",
      "type": "string"
    },
    "windows": {
      "description": "How many windows the session holds.",
      "minimum": 0,
      "type": "integer"
    }
  },
  "required": [
    "id",
    "name",
    "windows",
    "attached"
  ],
  "type": "object"
}
```

Tool annotations

```json
{
  "destructiveHint": false,
  "idempotentHint": true,
  "openWorldHint": false,
  "readOnlyHint": false,
  "title": "Rename Session"
}
```
