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.

create_window

Start a pane’s configured process; accepts no command payload. Add a window to a session and return it with its pane.

All TypeScript tools · JSON · Source

Arguments

name optional · string
Name for the new window.
session required · string
Session id ($1) or name.
startDirectory optional · string
Working directory for the new pane. Defaults to the session's.

Schemas

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

Input schema
{
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"name": {
"description": "Name for the new window.",
"type": "string",
"x-libtmux-tmux-format": "literalized-once"
},
"session": {
"description": "Session id ($1) or name.",
"type": "string"
},
"startDirectory": {
"description": "Working directory for the new pane. Defaults to the session's.",
"type": "string",
"x-libtmux-tmux-format": "literalized-once"
}
},
"required": [
"session"
],
"type": "object"
}
Output schema
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"paneId": {
"description": "Stable pane id, e.g. %1.",
"pattern": "^%\\d+$",
"type": "string"
},
"window": {
"additionalProperties": false,
"properties": {
"id": {
"description": "Stable window id, e.g. @1.",
"pattern": "^@\\d+$",
"type": "string"
},
"layout": {
"description": "tmux's observed saved layout, including any resizing or pruning; feed it back only when metadataComplete is true.",
"type": "string"
},
"metadataComplete": {
"description": "Whether every projected metadata string is complete.",
"type": "boolean"
},
"name": {
"type": "string"
},
"omittedMetadataBytes": {
"description": "UTF-8 bytes omitted from projected metadata strings.",
"maximum": 9007199254740991,
"minimum": 0,
"type": "integer"
},
"omittedPlacements": {
"description": "Later placements omitted.",
"maximum": 9007199254740991,
"minimum": 0,
"type": "integer"
},
"panes": {
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
"placements": {
"description": "Retained sessions and indexes where this window is linked.",
"items": {
"additionalProperties": false,
"properties": {
"active": {
"description": "Whether this placement is current in its session.",
"type": "boolean"
},
"index": {
"description": "The window index in this session.",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
"sessionId": {
"description": "Stable session id, e.g. $1.",
"pattern": "^\\$\\d+$",
"type": "string"
},
"sessionName": {
"type": "string"
}
},
"required": [
"index",
"sessionId",
"sessionName",
"active"
],
"type": "object"
},
"type": "array"
},
"placementsComplete": {
"description": "Whether placements contains every placement.",
"type": "boolean"
},
"zoomed": {
"type": "boolean"
}
},
"required": [
"id",
"layout",
"metadataComplete",
"name",
"omittedMetadataBytes",
"panes",
"omittedPlacements",
"placements",
"placementsComplete",
"zoomed"
],
"type": "object"
}
},
"required": [
"paneId",
"window"
],
"type": "object"
}
Tool annotations
{
"destructiveHint": true,
"idempotentHint": false,
"openWorldHint": true,
"readOnlyHint": false
}
Esc

Type to search.