tool MCPlatest

`split_window`

split_window( direction?: "above" | "below" | "left" | "right", paneId: string, startDirectory?: string, )

tool [source]¶

Start a pane’s configured process; accepts no command payload. Split a pane and return the new one. Direction is where the new pane goes relative to the one you split.

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

Arguments#

direction? ("above" | "below" | "left" | "right") #

Default below.
paneId (string) #

Stable pane id, e.g. %1.

pattern
"^%\\d+$"
startDirectory? (string) #

Defaults to the directory the pane being split is in.

Result#

Returns object

pane (object) #
- active (boolean) #
  
  Whether this is its window’s active pane.
- command (string) #
  
  The command tmux reports running in it.
- cwd (string) #
  
  Its current working directory.
- dead (boolean) #
  
  Whether its process exited and remain-on-exit kept it.
- height (integer) #
  
  minimum
  -9007199254740991
  maximum
  9007199254740991
- id (string) #
  
  Stable pane id. Prefer this for entity-scoped targeting.
  
  pattern
  "^%\\d+$"
- index (integer) #
  
  minimum
  -9007199254740991
  maximum
  9007199254740991
- isAttended (boolean) #
  
  A person is currently looking at this pane.
- isCallerPane (boolean) #
  
  This is the pane this MCP server runs in.
- metadataComplete (boolean) #
  
  Whether every projected metadata string is complete.
- omittedMetadataBytes (integer) #
  
  UTF-8 bytes omitted from projected metadata strings.
  
  minimum
  0
  maximum
  9007199254740991
- omittedPlacements (integer) #
  
  Later placements omitted.
  
  minimum
  0
  maximum
  9007199254740991
- placements (Array<object>) #
  
  Retained session and window indexes through which this pane is reachable.
  - Items (object) #
    - 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.
- title (string) #
- width (integer) #
  
  minimum
  -9007199254740991
  maximum
  9007199254740991
- windowId (string) #
  
  Stable window id, e.g. @1.
  
  pattern
  "^@\\d+$"
- windowName (string) #
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": {
    "direction": {
      "description": "Default below.",
      "enum": [
        "above",
        "below",
        "left",
        "right"
      ],
      "type": "string"
    },
    "paneId": {
      "description": "Stable pane id, e.g. %1.",
      "pattern": "^%\\d+$",
      "type": "string"
    },
    "startDirectory": {
      "description": "Defaults to the directory the pane being split is in.",
      "type": "string",
      "x-libtmux-tmux-format": "literalized-once"
    }
  },
  "required": [
    "paneId"
  ],
  "type": "object"
}

Output schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "additionalProperties": false,
  "properties": {
    "pane": {
      "additionalProperties": false,
      "properties": {
        "active": {
          "description": "Whether this is its window's active pane.",
          "type": "boolean"
        },
        "command": {
          "description": "The command tmux reports running in it.",
          "type": "string"
        },
        "cwd": {
          "description": "Its current working directory.",
          "type": "string"
        },
        "dead": {
          "description": "Whether its process exited and remain-on-exit kept it.",
          "type": "boolean"
        },
        "height": {
          "maximum": 9007199254740991,
          "minimum": -9007199254740991,
          "type": "integer"
        },
        "id": {
          "description": "Stable pane id. Prefer this for entity-scoped targeting.",
          "pattern": "^%\\d+$",
          "type": "string"
        },
        "index": {
          "maximum": 9007199254740991,
          "minimum": -9007199254740991,
          "type": "integer"
        },
        "isAttended": {
          "description": "A person is currently looking at this pane.",
          "type": "boolean"
        },
        "isCallerPane": {
          "description": "This is the pane this MCP server runs in.",
          "type": "boolean"
        },
        "metadataComplete": {
          "description": "Whether every projected metadata string is complete.",
          "type": "boolean"
        },
        "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"
        },
        "placements": {
          "description": "Retained session and window indexes through which this pane is reachable.",
          "items": {
            "additionalProperties": false,
            "properties": {
              "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"
            ],
            "type": "object"
          },
          "type": "array"
        },
        "placementsComplete": {
          "description": "Whether placements contains every placement.",
          "type": "boolean"
        },
        "title": {
          "type": "string"
        },
        "width": {
          "maximum": 9007199254740991,
          "minimum": -9007199254740991,
          "type": "integer"
        },
        "windowId": {
          "description": "Stable window id, e.g. @1.",
          "pattern": "^@\\d+$",
          "type": "string"
        },
        "windowName": {
          "type": "string"
        }
      },
      "required": [
        "active",
        "command",
        "cwd",
        "dead",
        "height",
        "id",
        "index",
        "isAttended",
        "isCallerPane",
        "metadataComplete",
        "omittedMetadataBytes",
        "omittedPlacements",
        "placements",
        "placementsComplete",
        "title",
        "width",
        "windowId",
        "windowName"
      ],
      "type": "object"
    }
  },
  "required": [
    "pane"
  ],
  "type": "object"
}

Scripting & web

Compiled & native

JVM

.NET

BEAM

tmux

`split_window`

Arguments#

Result#

Annotations#

Protocol data#