MCPpre-alphaAPI Reference

Choose documentation 3

stable

Current version

stable
English

Prerelease This site documents an alpha of libtmux. Its structure, URLs and APIs are subject to change.

libtmux_mcp.tools.option_tools.show_option

libtmux_mcp.tools.option_tools.show_option ( option: str, scope: t.Literal["server", "session", "window", "pane"] | None = None, target: str | None = None, global_: bool = False, socket_name: str | None = None, ) → OptionResult

Show a tmux option value.

Description#

Use to check tmux configuration values such as history-limit, mouse support, or status bar settings.

Parameters
  • option (str) # – The tmux option name to query.

  • scope (t.Literal["server", "session", "window", "pane"] | None) # – Option scope.

  • target (str | None) # – 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) # – Whether to query the global option.

  • socket_name (str | None) # – tmux socket name.

Returns

OptionResult Option name and its value.

Esc

Type to search.

Reference preview Open reference