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_window

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

All Rust tools · JSON · Source

Arguments

name required · string
The new name. tmux then stops renaming the window automatically.
window required · string
The `@`-prefixed window id.

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 then stops renaming the window automatically.",
"type": "string"
},
"window": {
"description": "The `@`-prefixed window id.",
"type": "string"
}
},
"required": [
"window",
"name"
],
"type": "object"
}
Output schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"active": {
"description": "Whether this is the session's active window.",
"type": "boolean"
},
"id": {
"description": "The `@`-prefixed tmux identity.",
"type": "string"
},
"index": {
"description": "The window's index within that session.",
"format": "int32",
"type": "integer"
},
"linked": {
"description": "Whether more than one session links this window.",
"type": "boolean"
},
"name": {
"description": "The window name.",
"type": "string"
},
"panes": {
"description": "How many panes the window holds.",
"minimum": 0,
"type": "integer"
},
"session_id": {
"description": "The session this window was reached through.",
"type": "string"
}
},
"required": [
"id",
"session_id",
"index",
"name",
"panes",
"active",
"linked"
],
"type": "object"
}
Tool annotations
{
"destructiveHint": false,
"idempotentHint": true,
"openWorldHint": false,
"readOnlyHint": false,
"title": "Rename Window"
}
Esc

Type to search.