mcp.src.TmuxTools
Rust
- Python Unavailable
- Ruby Unavailable
- Lua Unavailable
- TypeScript Unavailable
- Rust
- Go Unavailable
- Java Unavailable
- .NET Unavailable
- C++ Unavailable
- Swift Unavailable
-
A tmux server presented as MCP tools.
Members
-
Expose one tmux server, locating this process within it.
-
Expose one tmux server, saying explicitly where this process is and how much of the surface it may use.
The environment is process-wide, so a test that needs a caller or a selection cannot set one without disturbing every other test. This is how it says so instead.
Discussed in Rust MCP API
- offered ( self ) Vec<rmcp::model::Tool>
-
The tools this server offers after startup selection.
Discussed in Rust MCP API
-
The pane this process runs in, when tmux named a complete identity.
Reported without checking it against the server, because this is for saying what the environment claimed rather than for deciding anything.
-
Whether the inherited caller context is set but malformed, which makes pane-input and teardown tools refuse every call.
- get_session_info ( self , Parameters(crate::SessionArgs { session }) : Parameters<crate::SessionArgs> ) Result<Json<SessionView>, ToolError>
- get_window_info ( self , Parameters(crate::WindowArgs { window }) : Parameters<crate::WindowArgs> ) Result<Json<WindowView>, ToolError>
- get_pane_info ( self , Parameters(crate::PaneArgs { pane }) : Parameters<crate::PaneArgs> ) Result<Json<PaneView>, ToolError>
- find_pane_by_position ( self , Parameters(PositionArgs { window, corner }) : Parameters<PositionArgs> ) Result<Json<PaneView>, ToolError>
- get_tmux_variables ( self , Parameters(VariablesArgs { names, pane }) : Parameters<VariablesArgs> ) Result<Json<VariablesValue>, ToolError>
- rename_session ( self , Parameters(RenameSessionArgs { session, name }) : Parameters<RenameSessionArgs> ) Result<Json<SessionView>, ToolError>
- rename_window ( self , Parameters(RenameWindowArgs { window, name }) : Parameters<RenameWindowArgs> ) Result<Json<WindowView>, ToolError>
- resize_window ( self , Parameters(WindowSizeArgs { window, width, height, }) : Parameters<WindowSizeArgs> ) Result<Json<WindowView>, ToolError>
- move_window ( self , Parameters(MoveWindowArgs { window, destination_session, destination_index, }) : Parameters<MoveWindowArgs> ) Result<Json<WindowView>, ToolError>
- swap_pane ( self , Parameters(SwapPaneArgs { source_pane, target_pane, }) : Parameters<SwapPaneArgs> ) Result<Json<PaneView>, ToolError>
- set_pane_title ( self , Parameters(PaneTitleArgs { pane, title }) : Parameters<PaneTitleArgs> ) Result<Json<PaneView>, ToolError>
- set_mouse_enabled ( self , Parameters(SessionFlagArgs { session, enabled }) : Parameters<SessionFlagArgs> ) Result<Json<SettingChanged>, ToolError>
- set_history_limit ( self , Parameters(HistoryLimitArgs { session, limit }) : Parameters<HistoryLimitArgs> ) Result<Json<SettingChanged>, ToolError>
- create_window ( self , Parameters(CreateWindowArgs { session, name, start_directory, }) : Parameters<CreateWindowArgs> ) Result<Json<WindowView>, ToolError>
- split_window ( self , Parameters(SplitWindowArgs { pane, direction, percent, start_directory, }) : Parameters<SplitWindowArgs> ) Result<Json<PaneView>, ToolError>
- respawn_pane_configured ( self , Parameters(RespawnArgs { pane, kill_first }) : Parameters<RespawnArgs> ) Result<Json<PaneView>, ToolError>
- set_synchronize_panes ( self , Parameters(WindowFlagArgs { window, enabled }) : Parameters<WindowFlagArgs> ) Result<Json<SettingChanged>, ToolError>
- send_keys_batch ( self , Parameters(SendBatchArgs { operations, on_error, }) : Parameters<SendBatchArgs> ) Result<Json<BatchResult>, ToolError>
- call_read_tools_batch ( self , Parameters(ReadBatchArgs { operations, on_error, }) : Parameters<ReadBatchArgs> , context : RequestContext<rmcp::RoleServer> ) Result<Json<BatchResult>, ToolError>
- kill_window ( self , Parameters(WindowArgs { window }) : Parameters<WindowArgs> ) Result<Json<Killed>, ToolError>
-
Kill one window.
-
Kill one pane.
- create_session ( self , Parameters(CreateSessionArgs { name, start_directory, }) : Parameters<CreateSessionArgs> ) Result<Json<SessionView>, ToolError>
-
Create a detached session.
- kill_session ( self , Parameters(SessionArgs { session }) : Parameters<SessionArgs> ) Result<Json<Killed>, ToolError>
-
Kill a session and everything in it.
- resize_pane ( self , Parameters(ResizePaneArgs { pane, direction, cells, }) : Parameters<ResizePaneArgs> ) Result<Json<Size>, ToolError>
-
Move one edge of a pane.
- send_keys ( self , Parameters(args) : Parameters<SendKeysArgs> ) Result<Json<Sent>, ToolError>
-
Type text into a pane, or press keys in it.
- select_pane ( self , Parameters(SelectPaneArgs { pane, direction }) : Parameters<SelectPaneArgs> ) Result<Json<PaneView>, ToolError>
-
Move focus to a pane, or to the one beside it.
- select_window ( self , Parameters(SelectWindowArgs { window, direction }) : Parameters<SelectWindowArgs> ) Result<Json<Windows>, ToolError>
-
Move focus to a window, or to the one beside it.
- select_layout ( self , Parameters(SelectLayoutArgs { window, layout }) : Parameters<SelectLayoutArgs> ) Result<Json<Layout>, ToolError>
-
Arrange a window's panes.
- clear_pane ( self , Parameters(PaneArgs { pane }) : Parameters<PaneArgs> ) Result<Json<PaneChanged>, ToolError>
-
Empty a pane's scrollback.
- paste_text ( self , Parameters(PasteTextArgs { pane, text, enter }) : Parameters<PasteTextArgs> ) Result<Json<Pasted>, ToolError>
-
Deliver text to a pane without typing it.
- signal_channel ( self , Parameters(ChannelArgs { channel, .. }) : Parameters<ChannelArgs> ) Result<Json<ChannelSignal>, ToolError>
-
Signal a
wait-forchannel.
-
List every session on the server.
Discussed in Rust MCP examples
-
List every window on the server, one row per session link.
-
List every pane on the server.
-
Report the whole hierarchy in one call.
- capture_pane ( self , Parameters(CapturePaneArgs { pane, history, last_command, start, end, }) : Parameters<CapturePaneArgs> ) Result<Json<Capture>, ToolError>
-
Read one pane's contents.
- snapshot_pane ( self , Parameters(SnapshotArgs { pane, max_lines, history, }) : Parameters<SnapshotArgs> ) Result<Json<Snapshot>, ToolError>
-
Report pane state and bounded content in one answer.
- search_panes ( self , Parameters(SearchPanesArgs { pattern, regex, match_case, history, session, window, }) : Parameters<SearchPanesArgs> ) Result<Json<Matches>, ToolError>
-
Find which panes are showing something.
- show_option ( self , Parameters(OptionArgs { name, scope, target, .. }) : Parameters<OptionArgs> ) Result<Json<OptionValue>, ToolError>
-
Read a tmux option.
- show_environment ( self , Parameters(ShowEnvironmentArgs { session }) : Parameters<ShowEnvironmentArgs> ) Result<Json<Environment>, ToolError>
-
Read the names in a tmux environment, and the values the operator allowed.
- show_hooks ( self , Parameters(ShowHooksArgs { session }) : Parameters<ShowHooksArgs> ) Result<Json<Hooks>, ToolError>
-
Read the hooks tmux runs on its own events.
- run_command ( self , Parameters(RunCommandArgs { pane, command, seconds, suppress_history, }) : Parameters<RunCommandArgs> , cancelled : tokio_util::sync::CancellationToken , reporter : Reporter ) Result<Json<RunView>, ToolError>
-
Run a command in a pane and report how it went.
- wait_for_text ( self , Parameters(WaitForTextArgs { pane, patterns, stop, regex, match_case, seconds, }) : Parameters<WaitForTextArgs> , cancelled : tokio_util::sync::CancellationToken , reporter : Reporter ) Result<Json<WaitView>, ToolError>
-
Wait until a pane writes something a caller is looking for.
Discussed in Rust MCP topics
- capture_since ( self , Parameters(CaptureSinceArgs { pane, cursor }) : Parameters<CaptureSinceArgs> ) Result<Json<Since>, ToolError>
-
Report what a pane has written since the last look.
Discussed in Rust MCP topics
- wait_for_channel ( self , Parameters(ChannelArgs { channel, seconds }) : Parameters<ChannelArgs> ) Result<Json<ChannelWait>, ToolError>
-
Wait for a
wait-forchannel to be signalled.