tmux-mcp

io.github.fr1sk由 GitHub 账号 fr1sk 发布v0.3.3更新于 Oct 24, 2026

MCP server for tmux — browse sessions, capture output, send commands.

概览

AI 生成的概览

本地 MCP 服务器,让 AI 助手浏览 tmux 会话、窗口和窗格,读取终端输出,并发送命令或按键序列。

可以做什么
列出会话、窗口和窗格及其状态、尺寸和运行中的命令,并可重命名以便准确定位。捕获任意窗格的可见输出和回滚内容,最多 5000 行。向窗格发送 shell 命令或 Ctrl-C、Escape 等原始按键,并在可配置的等待后读取结果。创建会话、窗口和拆分窗格,可指定工作目录和初始命令。终止会话、窗口或单个窗格。
适用场景
适合在 tmux 中工作时使用:让助手查看正在运行的开发服务器、日志、测试运行或编译错误,并在可见、可审计的终端会话中执行命令,而不是在不可见的 shell 中。
运行要求
作为本地进程从 npm 安装运行,需要 Node.js 18 或更高版本,且 tmux 位于 PATH 中。可选环境变量 TMUX_MCP_ALWAYS_USE 和 TMUX_MCP_DEFAULT_SESSION 用于控制是否将命令路由到指定会话。无需账号或 API 密钥。
安装前请注意
提供不受限制的本地 shell 访问:send_keys 以及 new_session、new_window、split_pane 的 command 参数会以你的权限执行任意命令,且没有沙箱。capture_pane 返回原始终端文本,可能包含 API 密钥、令牌、密码或 SSH 私钥。终止类工具具有破坏性且无法撤销。仅在可信的本地环境中使用,切勿暴露给不可信的助手或可网络访问的主机。

安装

在 SourceWeft 中

  1. 打开 控制台中的 tmux-mcp,将其添加到工作区。
  2. 为需要使用其工具的对话启用该服务。

Desktop only,通过 STDIO。 STDIO 服务会启动本地进程,因此需要 SourceWeft 桌面宿主。

其他 MCP 客户端

参照 仓库 中的启动说明。

README

tmux-mcp

[tmux-mcp logo]

MCP server that gives AI assistants full visibility into your tmux sessions — browse sessions, windows, and panes, read terminal output, and send commands.

Watch your AI agent work in real-time. Enable TMUX_MCP_ALWAYS_USE to force every shell command through a named tmux session instead of direct Bash — every command your AI runs appears live in your terminal, fully auditable.

Works with Claude Code, OpenCode, Cursor, Windsurf, and any MCP-compatible host.

What it can do

Read your terminal state

  • List every active tmux session with window count, creation time, and attached status
  • List windows inside a session — index, name, pane count, which one is active
  • List panes inside a window — size, running command, which one is active

See what's on screen

  • Capture the visible output of any pane — up to 5 000 lines of scrollback
  • Read logs, compiler errors, server output, test runs — anything in your terminal

Create and organise

  • Create sessions, windows, and panes with a working directory and an initial command
  • Split panes horizontally or vertically
  • Rename sessions and windows for reliable targeting

Clean up

  • Kill sessions, windows, or individual panes

Control panes

  • Send shell commands to any pane and immediately read the output
  • Send raw key sequences: C-c to interrupt, Escape to exit, arrow keys, etc.
  • Configurable wait time before capturing so long-running commands have time to finish

Error-safe

  • Bad target? No tmux server? Returns a readable error message instead of crashing

Tools

list_sessions

Lists all active tmux sessions. No parameters.

Returns: session name, number of windows, creation time, attached/detached status.

list_windows

Lists windows inside a session.

ParameterTypeDescription
sessionstringSession name (from list_sessions)

Returns: window index, name, pane count, whether it's the active window.

list_panes

Lists panes inside a session or window.

ParameterTypeDescription
targetstringSession name (work) or session:window (work:0)

Returns: pane index, title, dimensions (e.g. 220x50), whether it's active, running command.

capture_pane

Captures the current terminal output of a pane.

ParameterTypeDefaultDescription
targetstring—Pane target: session:window.pane (e.g. work:0.0)
linesnumber150Lines of scrollback to include (max 5000)

Returns: raw terminal text as it appears on screen.

Security note: pane output can contain environment variables, API keys, tokens, and credentials if they were printed to the terminal. Only use this server in trusted local environments.

send_keys

Sends a command or key sequence to a pane and captures the result.

ParameterTypeDefaultDescription
targetstring—Pane target: session:window.pane
keysstring—Command or tmux key notation (C-c, Escape, Up, etc.)
enterbooleantruePress Enter after the keys
capture_linesnumber50Lines to capture after sending
wait_msnumber400Milliseconds to wait before capturing

Returns: confirmation + pane output after the command ran.

new_session

Creates a new detached tmux session.

ParameterTypeDescription
namestringSession name. Omit to let tmux auto-assign one.
cwdstringWorking directory for the session.
commandstringShell command to run immediately in the first window.

new_window

Creates a new window inside an existing session.

ParameterTypeDescription
sessionstringSession to create the window in.
namestringWindow name.
cwdstringWorking directory for the new window.
commandstringShell command to run immediately.

split_pane

Splits a pane into two.

ParameterTypeDefaultDescription
targetstring—Pane or window to split: session:window.pane
directionhorizontal | verticalhorizontalhorizontal = left/right split, vertical = top/bottom
cwdstring—Working directory for the new pane.
commandstring—Shell command to run in the new pane.
sizenumber—Size of the new pane as a percentage (1–99).

kill_session

Kills a session and all its windows and panes. Destructive — cannot be undone.

ParameterTypeDescription
sessionstringSession name to kill.

kill_window

Kills a window and all its panes. Destructive.

ParameterTypeDescription
targetstringWindow target: session:window

kill_pane

Kills a single pane and its running process. Destructive.

ParameterTypeDescription
targetstringPane target: session:window.pane

rename_session

ParameterTypeDescription
sessionstringCurrent session name.
new_namestringNew name.

rename_window

ParameterTypeDescription
targetstringWindow target: session:window
new_namestringNew name.

Target format

All tools use tmux's standard session:window.pane notation:

work           →  session named "work"work:0         →  window 0 of session "work"work:0.0       →  pane 0, window 0, session "work"work:editor.1  →  pane 1 of window named "editor" in session "work"

Use list_sessions → list_windows → list_panes to discover the right target before calling capture_pane or send_keys.

Install

bash
npm install -g @fr1sk/tmux-mcp

Configure

OpenCode (~/.config/opencode/opencode.json)

json
{  "mcp": {    "tmux": {      "type": "local",      "command": ["tmux-mcp"]    }  }}

Claude Code (~/.claude/settings.json)

json
{  "mcpServers": {    "tmux": {      "command": "tmux-mcp"    }  }}

Cursor / Windsurf (mcp.json)

json
{  "mcpServers": {    "tmux": {      "command": "tmux-mcp"    }  }}

Usage examples

What tmux sessions do I have running?
Show me the output of my dev server — it's in the work session
My tests are failing, check what's in work:1.0
Run git status in my work session and show me the output
Send Ctrl-C to work:0.0, the process is stuck
Tail the last 300 lines from the logs pane in my api session
Create a new session called 'dev' in ~/Projects/myapp and run npm run dev
Split work:0.0 vertically and run npm test in the new pane
Rename session 'new' to 'api'
Kill the old session named 'temp'

Environment variables

Set these in your MCP client config under environment to control agent behavior.

VariableDefaultDescription
TMUX_MCP_DEFAULT_SESSION—Session name the agent routes commands to when alwaysUseTmux is on
TMUX_MCP_ALWAYS_USEfalseSet to "true" to route all shell commands through tmux instead of direct Bash

When both are set, the get_config tool returns an instructions field the agent uses to automatically route every shell command through send_keys in the configured session.

Example (OpenCode):

json
{  "mcp": {    "tmux": {      "type": "local",      "command": ["tmux-mcp"],      "environment": {        "TMUX_MCP_ALWAYS_USE": "true",        "TMUX_MCP_DEFAULT_SESSION": "dev"      }    }  }}

Security

This server provides unrestricted local shell access through tmux:

  • capture_pane — returns raw terminal output, which may include environment variables, API keys, tokens, database passwords, and SSH private keys if they were printed to the terminal.
  • send_keys — executes arbitrary shell commands in the target pane. Any command the AI sends runs in your shell with your permissions.
  • command parameter on new_session, new_window, and split_pane — passed directly to tmux, which runs it via $SHELL -c. No validation or sandboxing.

Only use this server in trusted local development environments. Never expose it to network-accessible MCP hosts or untrusted AI assistants.

Requirements

  • Node.js 18+
  • tmux on $PATH

来源:README.md,提交 22389f3

工具

0
SourceWeft 尚未在沙箱中启动过该软件包,因此其工具未知。

版本历史

1
  1. v0.3.3最新Sep 16, 2026

评分

已满足适用检查项的 50%

该评分衡量此收录条目的完整程度,依据注册中心条目、端点与公开来源计算得出。它不是对服务器本身的评价,也不表示服务器安全或当前可用:可连通性是带日期的检查结果,评分也不包含安装量或用户评价。

  • 近 30 天内可连通25 分

    请保持端点能够响应 MCP 握手;SourceWeft 每 30 天探测一次。

  • 已声明认证方式10 分

    请在注册中心条目中声明凭据请求头,或保持端点能够响应探测,以便判定其认证方式。

  • 已列出工具15 分

    请让服务器在无凭据时响应 tools/list,或发布可在沙箱中无凭据启动的软件包。

  • 描述必需15 分
  • 图标10 分
  • 文档15 分
  • 许可证10 分