show_option
Show a tmux option value.
Use to check tmux configuration values such as history-limit, mouse support, or status bar settings.
All Python tools · JSON · Source
Arguments
global_optional · boolean- Whether to query the global option.
Default:
false. optionrequired · string- The tmux option name to query.
scopeoptional- Option scope.
Default:
null. socket_nameoptional- tmux socket name.
Default:
null. targetoptional- 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.
Default:
null.
Schemas
The schema defines required fields, nested values, defaults, and validation constraints.
Input schema
{ "additionalProperties": false, "properties": { "global_": { "default": false, "description": "Whether to query the global option.", "type": "boolean" }, "option": { "description": "The tmux option name to query.", "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." } }, "required": [ "option" ], "type": "object"}Output schema
{ "description": "Result of a show_option call.", "properties": { "option": { "description": "Option name", "type": "string" }, "value": { "description": "Option value" } }, "required": [ "option", "value" ], "type": "object"}Tool annotations
{ "destructiveHint": true, "idempotentHint": false, "openWorldHint": true, "readOnlyHint": false}