Show option

show_option

show_option
readonly tool

Show a tmux option value.

Returns:

OptionResult

Use when you need to check a tmux configuration value — buffer limits, history size, status bar settings, etc.

Side effects: None. Readonly.

Example:

{
  "tool": "show_option",
  "arguments": {
    "option": "history-limit"
  }
}

Response:

{
  "option": "history-limit",
  "value": "2000"
}

Parameters

Parameter

Type

Required

Default

Description

option

str

yes

The tmux option name to query.

scope

enum

no

Option scope. One of: 'server', 'session', 'window', 'pane'.

target

str

no

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.

global_

bool

no

False

Whether to query the global option.

socket_name

str

no

tmux socket name.