libtmux_mcp.tools.pane_tools.display_message
-
Read tmux variables against a target and return the substituted text.
Description#
Use this when no dedicated tool covers the field you want, e.g. '#{window_zoomed_flag}', '#{pane_dead}', '#{client_activity}'.
Accepts literal text and '#{variable}' references. Format modifiers, conditionals, and jobs are refused: tmux expands '#{E:x}' by running x's value through the expander again, and a value can arrive from a pane rather than from the caller. For raw format syntax, run 'tmux display-message -p' through run_command, where the caller supplies it on a surface labelled execution.
Returned values can carry text a pane chose, such as a working directory or a running command.
- Parameters
-
-
format_string(str) # – Literal text and '#{variable}' references (e.g. '#{cursor_x} #{cursor_y}'). -
session_name(str | None) # – Session name for pane resolution. -
session_id(str | None) # – Session ID for pane resolution. -
socket_name(str | None) # – tmux socket name.
-
- Returns
-
str Expanded format string result.
- Raises
-
-
Expected
Tool – IfError format_stringcarries tmux format syntax other than#{variable}references.
-