ITerm MCP Server

ITerm MCP Server

site icon
2025.03.24 2
JavaScript终端集成自动化工具开发效率
iTerm-MCP-Server 是一个为 iTerm2 终端集成实现的 Model Context Protocol (MCP) 服务器。该服务器允许 AI 助手通过 Model Context Protocol 与 iTerm2 终端进行交互,提供终端会话的创建、管理和命令执行等功能。
View on GitHub

Overview

基本能力

产品定位

iTerm-MCP-Server 是一个终端集成工具,旨在通过 MCP 协议实现 AI 助手与 iTerm2 终端的交互。

核心功能

  • 创建和管理 iTerm2 终端会话
  • 在终端中执行命令
  • 读取终端输出
  • 列出活动终端
  • 关闭终端

适用场景

  • 开发者在开发过程中需要自动化终端操作
  • AI 助手需要通过终端执行命令并获取输出
  • 需要批量管理多个终端会话的场景

工具列表

  • open_terminal: 打开一个新的终端实例
  • execute_command: 在特定终端中执行命令
  • read_output: 从特定终端读取输出
  • close_terminal: 关闭特定终端
  • list_terminals: 列出所有活动终端及其信息

常见问题解答

  • 安全性: 服务器使用 Zod 模式验证所有输入,命令在隔离的终端会话中执行,并实现了适当的错误处理和输入清理。
  • 兼容性: 仅支持 macOS 和 iTerm2。

使用教程

使用依赖

  • Node.js >= 14.x
  • iTerm2
  • macOS

安装教程

  1. 确保已安装 Node.js 和 iTerm2。
  2. 通过 npm 安装服务器: bash npm install -g iterm_mcp_server
  3. 启动服务器: bash npx iterm_mcp_server

调试方式

  1. 启动服务器后,可以通过 MCP 协议发送命令进行测试。
  2. 使用 list_terminals 命令检查活动终端列表。
  3. 使用 execute_command 执行简单命令(如 ls)并检查输出。

配置

标准配置

服务器使用标准 MCP 配置选项,无需额外配置。

Cursor 配置

要与 Cursor 一起使用此服务器,请将以下配置添加到 ~/.cursor/mcp.json 文件中:

{
  "mcpServers": {
    "terminal": {
      "command": "npx",
      "args": ["iterm_mcp_server"]
    }
  }
}

许可证

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