Python MCP reference

tool MCPlatest

`set_option`

Set a tmux option value.

Some option values are executable. tmux runs a #(...) job inside the status formats when it draws them, and repeats it on the status interval; default-command and default-shell decide what every future pane runs, and command-alias rewrites later commands. The value is stored verbatim, so an option that interprets it later runs what is stored, not what this call did.

Use to change tmux behavior at runtime. Common uses: adjusting history-limit, enabling mouse support, changing status bar format.

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

Arguments#

global_? = false (boolean) #

Whether to set the global option.
option (string) #

The tmux option name to set.
scope? = null ("server" | "session" | "window" | "pane" | null) #

Option scope.
socket_name? = null (string | null) #

tmux socket name.
target? = null (string | null) #

Target identifier. For session scope: session name (e.g. ‘mysession’). For window scope: window ID (e.g. ‘@1’). For pane scope: pane ID (e.g. ‘%1’). Requires scope.
value (string) #

The value to set.

No other arguments are accepted.

Result#

Returns object

option (string) #

Option name
status (string) #

Operation status
value (string) #

Value that was set

Annotations#

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

Protocol data#

Use the complete advertised contract for validation and client integration.

Input schema

{
  "additionalProperties": false,
  "properties": {
    "global_": {
      "default": false,
      "description": "Whether to set the global option.",
      "type": "boolean"
    },
    "option": {
      "description": "The tmux option name to set.",
      "type": "string"
    },
    "scope": {
      "anyOf": [
        {
          "enum": [
            "server",
            "session",
            "window",
            "pane"
          ],
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Option scope."
    },
    "socket_name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "tmux socket name."
    },
    "target": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Target identifier. For session scope: session name\n(e.g. 'mysession'). For window scope: window ID (e.g. '@1').\nFor pane scope: pane ID (e.g. '%1'). Requires scope."
    },
    "value": {
      "description": "The value to set.",
      "type": "string"
    }
  },
  "required": [
    "option",
    "value"
  ],
  "type": "object"
}

Output schema

{
  "description": "Result of a set_option call.",
  "properties": {
    "option": {
      "description": "Option name",
      "type": "string"
    },
    "status": {
      "description": "Operation status",
      "type": "string"
    },
    "value": {
      "description": "Value that was set",
      "type": "string"
    }
  },
  "required": [
    "option",
    "value",
    "status"
  ],
  "type": "object"
}

Scripting & web

Compiled & native

JVM

.NET

tmux

`set_option`

Arguments#

Result#

Annotations#

Protocol data#