Resources
Browse the data the server exposes through resources/read. Resource templates describe URI patterns and the variables used to select a resource.
The reference configuration advertises 3 resources and resource templates. Your server’s available objects depend on its configuration. Setup documentation explains how to connect a client.
Resource templates3 objects#
Acquire metadata through tmux_snapshot with its default page limit. Encode every URI component; generation must match discovery. Reports capture interval and truncation.
Read a retained tmux_snapshot page without refreshing it. Encode the cursor component; endpoint, generation and entity must match its captured query.
Capture an exact pane through tmux_capture with its default byte/line bounds, without cursor tracking. Percent-encode pane IDs. Invalid UTF-8 is an application/octet-stream blob; _meta includes capture interval, truncation and unknown history continuity.
Reference configuration
modeexplicit CLI optionstoolstmux_capabilities,tmux_snapshot,tmux_capture,tmux_wait,tmux_create,tmux_send,tmux_close,tmux_run
Protocol version: 2025-11-25. Download the full protocol catalog.
Source: libtmux/libtmux-ruby@0e6b860a5da7.
The language API reference documents embedding and implementation types.