JinDaGe - iTerm Terminal MCP Details

article

README

🚀 iterm-mcp

iterm-mcp是一款为您的iTerm会话提供访问的模型上下文协议（Model Context Protocol）服务器。它能让模型高效利用令牌，自然集成iTerm，并实现完整的终端控制和REPL支持。

主要图片

🚀 快速开始

iterm-mcp是一款强大的模型上下文协议服务器，可与Claude Desktop等MCP客户端无缝集成。它能让模型高效地与iTerm会话进行交互，为您带来全新的使用体验。

✨ 主要特性

高效令牌使用：iterm-mcp使模型能够仅查看其感兴趣的输出部分。模型通常只想查看长命令的最后几行输出。
自然集成：您可以与模型共享iTerm。您可以询问屏幕上的内容，或委托任务给模型，并观察其执行每一步操作。
完整的终端控制和REPL支持：模型可以启动并交互使用REPL环境，还可以发送控制字符（如ctrl-c、ctrl-z等）。
轻量级依赖：iterm-mcp基于最小的依赖构建，可通过npx运行。它专为Claude Desktop和其他MCP客户端设计，开箱即用。

⚠️ 安全注意事项

⚠️ 重要提示

用户需自行负责工具的安全使用。

无内置限制：iterm-mcp未对命令的安全性进行评估。

模型可能会以意外方式行为。用户需监控活动并在必要时终止操作。

对于多步骤任务，可能需要在模型偏离轨道时中断它。从较小的、专注的任务开始，直至熟悉模型的行为。

🛠️ 工具

| 属性 | 详情 | |------|------| | write_to_terminal | 向当前iTerm终端写入内容，通常用于运行命令。返回命令输出的行数。 | | read_terminal_output | 从当前iTerm终端读取指定数量的行。 | | send_control_character | 向当前iTerm终端发送控制字符。 |

📋 要求

必须运行iTerm2
Node.js版本18或更高

📦 安装指南

与Claude Desktop配合使用

添加服务器配置：

在macOS上：~/Library/Application Support/Claude/claude_desktop_config.json
在Windows上：%APPDATA%/Claude/claude_desktop_config.json

{
  "mcpServers": {
    "iterm-mcp": {
      "command": "npx",
      "args": [
        "-y",
        "iterm-mcp"
      ]
    }
  }
}

通过Smithery安装

自动为Claude Desktop安装iTerm插件：

npx -y @smithery/cli install iterm-mcp --client claude

💻 使用示例

开发

安装依赖

yarn install

构建服务器

yarn run build

带自动重建的开发

yarn run watch

调试

由于MCP服务器通过标准输入和输出进行通信，调试可能具有挑战性。我们推荐使用MCP Inspector，它作为包脚本可用：

yarn run inspector
yarn debug <command>

Inspector会提供一个访问调试工具的浏览器URL。

iTerm Terminal