终端会话管理协议

iterm-mcp是一个模型上下文协议服务器,提供对iTerm会话的访问,允许模型检查终端输出并与终端交互。

  • by lite
  • TypeScript
  • 本地部署
  • 更新于
在 GitHub 查看 lite/iterm-mcp

使用说明

iterm 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必须正在运行
  • 节点版本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安装

通过以下方式自动安装iTerm for Claude Desktop 史密瑟里:

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

发展

安装依赖项:

yarn install

构建服务器:

yarn run build

对于自动重建的开发:

yarn run watch

调试

由于MCP服务器通过stdio进行通信,调试可能具有挑战性。我们建议使用 MCP检查员,可作为包脚本使用:

yarn run inspector
yarn debug <command>

检查器将提供一个URL,用于访问浏览器中的调试工具。