Resources¶
MCP resources are addressable documents the server exposes at
tmux:// URIs. Clients read them via resources/read. All
libtmux-mcp resources are
resource templates
— each URI includes a {?socket_name} query parameter for socket
isolation, plus structural path parameters ({session_name},
{pane_id}, …) so a single template covers every session, window,
or pane.
Every resource delivers a snapshot of the tmux hierarchy at call time. Agents use them for read-only inspection; any write workflow goes through the corresponding tools.
Available resources¶
get_sessionsList all tmux sessions.
get_sessionGet details of a specific tmux session.
get_session_windowsList all windows in a tmux session.
get_windowGet details of a specific window in a session.
get_paneGet details of a specific pane.
get_pane_contentCapture and return the content of a pane.
Sessions¶
get_sessions¶
tmux://sessions{?socket_name}List all tmux sessions.
- MIME type:
application/json
Parameters
Argument |
Type |
Required |
Description |
|---|---|---|---|
|
string | null |
no |
— |
get_session¶
tmux://sessions/{session_name}{?socket_name}Get details of a specific tmux session.
- MIME type:
application/json
Parameters
Argument |
Type |
Required |
Description |
|---|---|---|---|
|
string |
yes |
— |
|
string | null |
no |
— |
get_session_windows¶
tmux://sessions/{session_name}/windows{?socket_name}List all windows in a tmux session.
- MIME type:
application/json
Parameters
Argument |
Type |
Required |
Description |
|---|---|---|---|
|
string |
yes |
— |
|
string | null |
no |
— |
Windows¶
get_window¶
tmux://sessions/{session_name}/windows/{window_index}{?socket_name}Get details of a specific window in a session.
- MIME type:
application/json
Parameters
Argument |
Type |
Required |
Description |
|---|---|---|---|
|
string |
yes |
— |
|
string |
yes |
— |
|
string | null |
no |
— |
Panes¶
get_pane¶
tmux://panes/{pane_id}{?socket_name}Get details of a specific pane.
- MIME type:
application/json
Parameters
Argument |
Type |
Required |
Description |
|---|---|---|---|
|
string |
yes |
— |
|
string | null |
no |
— |
get_pane_content¶
tmux://panes/{pane_id}/content{?socket_name}Capture and return the content of a pane.
- MIME type:
text/plain
Parameters
Argument |
Type |
Required |
Description |
|---|---|---|---|
|
string |
yes |
— |
|
string | null |
no |
— |