MCPAPI Reference

Choose documentation 3

latest

Current version

latest
English

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

rename_session

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

All Rust tools · JSON · Source

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
{
"$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
{
"$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
{
"destructiveHint": false,
"idempotentHint": true,
"openWorldHint": false,
"readOnlyHint": false,
"title": "Rename Session"
}
Esc

Type to search.