tool MCPlatest

`create_window`

create_window( name?: string, session: string, startDirectory?: string, )

tool [source]¶

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

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

Arguments#

name? (string) #

Name for the new window.
session (string) #

Session id ($1) or name.
startDirectory? (string) #

Working directory for the new pane. Defaults to the session’s.

Result#

Returns object

paneId (string) #

Stable pane id, e.g. %1.

pattern
"^%\\d+$"
window (object) #
- id (string) #
  
  Stable window id, e.g. @1.
  
  pattern
  "^@\\d+$"
- layout (string) #
  
  tmux’s layout string; feed it back only when metadataComplete is true.
- metadataComplete (boolean) #
  
  Whether every projected metadata string is complete.
- name (string) #
- omittedMetadataBytes (integer) #
  
  UTF-8 bytes omitted from projected metadata strings.
  
  minimum
  0
  maximum
  9007199254740991
- omittedPlacements (integer) #
  
  Later placements omitted.
  
  minimum
  0
  maximum
  9007199254740991
- panes (integer) #
  
  minimum
  -9007199254740991
  maximum
  9007199254740991
- placements (Array<object>) #
  
  Retained sessions and indexes where this window is linked.
  - Items (object) #
    - active (boolean) #
      
      Whether this placement is current in its session.
    - index (integer) #
      
      The window index in this session.
      
      minimum
      -9007199254740991
      maximum
      9007199254740991
    - sessionId (string) #
      
      Stable session id, e.g. $1.
      
      pattern
      "^\\$\\d+$"
    - sessionName (string) #
    No other properties are accepted.
- placementsComplete (boolean) #
  
  Whether placements contains every placement.
- zoomed (boolean) #
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": "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 layout string; 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"
}

Scripting & web

Compiled & native

JVM

.NET

BEAM

tmux

`create_window`

Arguments#

Result#

Annotations#

Protocol data#