Ruby MCP reference

tool MCPv0.1.1

`tmux_close`

tmux_close()

tool [source]¶

Destroy one exact session, window or pane. Opt-in destructive operation; closing a session or window also removes its contained topology. Never selects by name or closes the daemon directly. Returns the final tmux client outcome.

MCP request method: tools/call Send tmux_close as the tool name, with the arguments below.
Tool selection: Opt in with --enable-tool tmux_close.

Arguments#

No named arguments.

Matches exactly one variant.

Variant 1 (object) #
- target (object | object | object) #
  
  Matches exactly one variant.
  - Variant 1 (object) #
    - generation (string) #
      
      minLength
      1
      maxLength
      128
    - id (string) #
      
      maxLength
      32
      pattern
      "^\\$[0-9]+$"
    - kind ("session") #
    No other properties are accepted.
  - Variant 2 (object) #
    - generation (string) #
      
      minLength
      1
      maxLength
      128
    - id (string) #
      
      maxLength
      32
      pattern
      "^@[0-9]+$"
    - kind ("window") #
    No other properties are accepted.
  - Variant 3 (object) #
    - generation (string) #
      
      minLength
      1
      maxLength
      128
    - id (string) #
      
      maxLength
      32
      pattern
      "^%[0-9]+$"
    - kind ("pane") #
    No other properties are accepted.
No other properties are accepted.

Result#

Returns object | object

Matches exactly one variant.

Variant 1 (object) #
- data (object) #
  - client_exit_status (0) #
  - delivery ("observed") #
  - target (object | object | object | object) #
    
    Matches exactly one variant.
    - Variant 1 (object) #
      - generation (string) #
        
        minLength
        1
        maxLength
        128
      - id (string) #
        
        maxLength
        32
        pattern
        "^\\$[0-9]+$"
      - kind ("session") #
      No other properties are accepted.
    - Variant 2 (object) #
      - generation (string) #
        
        minLength
        1
        maxLength
        128
      - id (string) #
        
        maxLength
        32
        pattern
        "^@[0-9]+$"
      - kind ("window") #
      No other properties are accepted.
    - Variant 3 (object) #
      - generation (string) #
        
        minLength
        1
        maxLength
        128
      - id (string) #
        
        maxLength
        32
        pattern
        "^%[0-9]+$"
      - kind ("pane") #
      No other properties are accepted.
    - Variant 4 (object) #
      - generation (string) #
        
        minLength
        1
        maxLength
        128
      - id (string) #
        
        maxLength
        32
        pattern
        "^@[0-9]+$"
      - index (integer) #
        
        minimum
        0
      - kind ("window_link") #
      - session_id (string) #
        
        maxLength
        32
        pattern
        "^\\$[0-9]+$"
      No other properties are accepted.
  No other properties are accepted.
- ok (true) #
No other properties are accepted.
Variant 2 (object) #
- error (object) #
  - code (string) #
  - delivery ("not_sent" | "possibly_sent" | "observed") #
  - effects? (object) #
    - created (Array<object | object | object | object>) #
      
      maxItems
      3
      - Items (object | object | object | object) #
        
        Matches exactly one variant.
        
        Variant 1 (object) #
        
        generation (string) #
        
        minLength
        1
        maxLength
        128
        
        id (string) #
        
        maxLength
        32
        pattern
        "^\\$[0-9]+$"
        
        kind ("session") #
        
        No other properties are accepted.
        
        Variant 2 (object) #
        
        generation (string) #
        
        minLength
        1
        maxLength
        128
        
        id (string) #
        
        maxLength
        32
        pattern
        "^@[0-9]+$"
        
        kind ("window") #
        
        No other properties are accepted.
        
        Variant 3 (object) #
        
        generation (string) #
        
        minLength
        1
        maxLength
        128
        
        id (string) #
        
        maxLength
        32
        pattern
        "^%[0-9]+$"
        
        kind ("pane") #
        
        No other properties are accepted.
        
        Variant 4 (object) #
        
        generation (string) #
        
        minLength
        1
        maxLength
        128
        
        id (string) #
        
        maxLength
        32
        pattern
        "^@[0-9]+$"
        
        index (integer) #
        
        minimum
        0
        
        kind ("window_link") #
        
        session_id (string) #
        
        maxLength
        32
        pattern
        "^\\$[0-9]+$"
        
        No other properties are accepted.
    - state ("none" | "known" | "unknown") #
    No other properties are accepted.
  - message (string) #
  No other properties are accepted.
- ok (false) #
No other properties are accepted.

Annotations#

destructiveHint: true
idempotentHint: false
openWorldHint: false
readOnlyHint: false

Protocol data#

Use the complete advertised contract for validation and client integration.

Input schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "oneOf": [
    {
      "additionalProperties": false,
      "properties": {
        "target": {
          "oneOf": [
            {
              "additionalProperties": false,
              "properties": {
                "generation": {
                  "maxLength": 128,
                  "minLength": 1,
                  "type": "string"
                },
                "id": {
                  "maxLength": 32,
                  "pattern": "^\\$[0-9]+$",
                  "type": "string"
                },
                "kind": {
                  "const": "session"
                }
              },
              "required": [
                "generation",
                "kind",
                "id"
              ],
              "type": "object"
            },
            {
              "additionalProperties": false,
              "properties": {
                "generation": {
                  "maxLength": 128,
                  "minLength": 1,
                  "type": "string"
                },
                "id": {
                  "maxLength": 32,
                  "pattern": "^@[0-9]+$",
                  "type": "string"
                },
                "kind": {
                  "const": "window"
                }
              },
              "required": [
                "generation",
                "kind",
                "id"
              ],
              "type": "object"
            },
            {
              "additionalProperties": false,
              "properties": {
                "generation": {
                  "maxLength": 128,
                  "minLength": 1,
                  "type": "string"
                },
                "id": {
                  "maxLength": 32,
                  "pattern": "^%[0-9]+$",
                  "type": "string"
                },
                "kind": {
                  "const": "pane"
                }
              },
              "required": [
                "generation",
                "kind",
                "id"
              ],
              "type": "object"
            }
          ]
        }
      },
      "required": [
        "target"
      ],
      "type": "object"
    }
  ],
  "type": "object"
}

Output schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "oneOf": [
    {
      "additionalProperties": false,
      "properties": {
        "data": {
          "additionalProperties": false,
          "properties": {
            "client_exit_status": {
              "const": 0
            },
            "delivery": {
              "const": "observed"
            },
            "target": {
              "oneOf": [
                {
                  "additionalProperties": false,
                  "properties": {
                    "generation": {
                      "maxLength": 128,
                      "minLength": 1,
                      "type": "string"
                    },
                    "id": {
                      "maxLength": 32,
                      "pattern": "^\\$[0-9]+$",
                      "type": "string"
                    },
                    "kind": {
                      "const": "session"
                    }
                  },
                  "required": [
                    "generation",
                    "kind",
                    "id"
                  ],
                  "type": "object"
                },
                {
                  "additionalProperties": false,
                  "properties": {
                    "generation": {
                      "maxLength": 128,
                      "minLength": 1,
                      "type": "string"
                    },
                    "id": {
                      "maxLength": 32,
                      "pattern": "^@[0-9]+$",
                      "type": "string"
                    },
                    "kind": {
                      "const": "window"
                    }
                  },
                  "required": [
                    "generation",
                    "kind",
                    "id"
                  ],
                  "type": "object"
                },
                {
                  "additionalProperties": false,
                  "properties": {
                    "generation": {
                      "maxLength": 128,
                      "minLength": 1,
                      "type": "string"
                    },
                    "id": {
                      "maxLength": 32,
                      "pattern": "^%[0-9]+$",
                      "type": "string"
                    },
                    "kind": {
                      "const": "pane"
                    }
                  },
                  "required": [
                    "generation",
                    "kind",
                    "id"
                  ],
                  "type": "object"
                },
                {
                  "additionalProperties": false,
                  "properties": {
                    "generation": {
                      "maxLength": 128,
                      "minLength": 1,
                      "type": "string"
                    },
                    "id": {
                      "maxLength": 32,
                      "pattern": "^@[0-9]+$",
                      "type": "string"
                    },
                    "index": {
                      "minimum": 0,
                      "type": "integer"
                    },
                    "kind": {
                      "const": "window_link"
                    },
                    "session_id": {
                      "maxLength": 32,
                      "pattern": "^\\$[0-9]+$",
                      "type": "string"
                    }
                  },
                  "required": [
                    "generation",
                    "kind",
                    "id",
                    "session_id",
                    "index"
                  ],
                  "type": "object"
                }
              ]
            }
          },
          "required": [
            "target",
            "delivery",
            "client_exit_status"
          ],
          "type": "object"
        },
        "ok": {
          "const": true
        }
      },
      "required": [
        "ok",
        "data"
      ],
      "type": "object"
    },
    {
      "additionalProperties": false,
      "properties": {
        "error": {
          "additionalProperties": false,
          "properties": {
            "code": {
              "type": "string"
            },
            "delivery": {
              "enum": [
                "not_sent",
                "possibly_sent",
                "observed"
              ]
            },
            "effects": {
              "additionalProperties": false,
              "properties": {
                "created": {
                  "items": {
                    "oneOf": [
                      {
                        "additionalProperties": false,
                        "properties": {
                          "generation": {
                            "maxLength": 128,
                            "minLength": 1,
                            "type": "string"
                          },
                          "id": {
                            "maxLength": 32,
                            "pattern": "^\\$[0-9]+$",
                            "type": "string"
                          },
                          "kind": {
                            "const": "session"
                          }
                        },
                        "required": [
                          "generation",
                          "kind",
                          "id"
                        ],
                        "type": "object"
                      },
                      {
                        "additionalProperties": false,
                        "properties": {
                          "generation": {
                            "maxLength": 128,
                            "minLength": 1,
                            "type": "string"
                          },
                          "id": {
                            "maxLength": 32,
                            "pattern": "^@[0-9]+$",
                            "type": "string"
                          },
                          "kind": {
                            "const": "window"
                          }
                        },
                        "required": [
                          "generation",
                          "kind",
                          "id"
                        ],
                        "type": "object"
                      },
                      {
                        "additionalProperties": false,
                        "properties": {
                          "generation": {
                            "maxLength": 128,
                            "minLength": 1,
                            "type": "string"
                          },
                          "id": {
                            "maxLength": 32,
                            "pattern": "^%[0-9]+$",
                            "type": "string"
                          },
                          "kind": {
                            "const": "pane"
                          }
                        },
                        "required": [
                          "generation",
                          "kind",
                          "id"
                        ],
                        "type": "object"
                      },
                      {
                        "additionalProperties": false,
                        "properties": {
                          "generation": {
                            "maxLength": 128,
                            "minLength": 1,
                            "type": "string"
                          },
                          "id": {
                            "maxLength": 32,
                            "pattern": "^@[0-9]+$",
                            "type": "string"
                          },
                          "index": {
                            "minimum": 0,
                            "type": "integer"
                          },
                          "kind": {
                            "const": "window_link"
                          },
                          "session_id": {
                            "maxLength": 32,
                            "pattern": "^\\$[0-9]+$",
                            "type": "string"
                          }
                        },
                        "required": [
                          "generation",
                          "kind",
                          "id",
                          "session_id",
                          "index"
                        ],
                        "type": "object"
                      }
                    ]
                  },
                  "maxItems": 3,
                  "type": "array"
                },
                "state": {
                  "enum": [
                    "none",
                    "known",
                    "unknown"
                  ]
                }
              },
              "required": [
                "state",
                "created"
              ],
              "type": "object"
            },
            "message": {
              "type": "string"
            }
          },
          "required": [
            "code",
            "message",
            "delivery"
          ],
          "type": "object"
        },
        "ok": {
          "const": false
        }
      },
      "required": [
        "ok",
        "error"
      ],
      "type": "object"
    }
  ],
  "type": "object"
}

Scripting & web

Compiled & native

JVM

.NET

BEAM

tmux

`tmux_close`

Arguments#

Result#

Annotations#

Protocol data#