Tmux MCP Server

Tmux MCP Server

site icon
2025.03.25 16
TypeScript终端管理AI 助手集成开发效率
Tmux MCP Server 是一个模型上下文协议服务器,使 Claude Desktop 能够与 tmux 会话交互并查看其内容。该集成允许 AI 助手读取、控制和观察终端会话。
View on GitHub

Overview

基本能力

产品定位

Tmux MCP Server 是一个用于终端会话管理的工具,特别适用于开发者和系统管理员,通过 AI 助手增强对 tmux 会话的控制和观察能力。

核心功能

  • 列出和搜索 tmux 会话
  • 查看和导航 tmux 窗口和窗格
  • 捕获和展示任何窗格的终端内容
  • 在 tmux 窗格中执行命令并获取结果(使用需谨慎 ⚠️)
  • 创建新的 tmux 会话和窗口

适用场景

  • 开发者需要 AI 助手协助管理多个终端会话
  • 系统管理员需要远程监控和控制终端会话
  • 团队协作时共享终端会话内容

工具列表

  • list-sessions: 列出所有活动的 tmux 会话
  • find-session: 按名称查找 tmux 会话
  • list-windows: 列出 tmux 会话中的窗口
  • list-panes: 列出 tmux 窗口中的窗格
  • capture-pane: 捕获 tmux 窗格的内容
  • create-session: 创建新的 tmux 会话
  • create-window: 在 tmux 会话中创建新窗口
  • execute-command: 在 tmux 窗格中执行命令
  • get-command-result: 获取执行命令的结果

使用教程

使用依赖

  • Node.js
  • tmux 已安装并运行

安装教程

  1. 配置 Claude Desktop,将以下内容添加到配置文件中:
"mcpServers": {
  "tmux": {
    "command": "npx",
    "args": ["-y", "tmux-mcp"]
  }
}
  1. 可选:指定命令行 shell 类型(默认为 bash
"mcpServers": {
  "tmux": {
    "command": "npx",
    "args": ["-y", "tmux-mcp", "--shell-type=fish"]
  }
}

调试方式

  • 使用 list-sessions 工具检查是否成功列出 tmux 会话
  • 使用 capture-pane 工具验证是否能正确捕获窗格内容
  • 使用 execute-command 工具测试命令执行功能

常见问题解答

  • 问题:MCP 服务器无法连接到 tmux 会话 解决方案:确保 tmux 已安装并运行,且 Node.js 环境配置正确
  • 问题:命令执行结果无法获取 解决方案:检查指定的 shell 类型是否正确,确保命令有明确的退出状态

许可证

该项目遵循 MIT 开源许可条款,请参阅 MIT 了解完整条款。