iTerm-MCP 使用教程

1. 项目介绍

iTerm-MCP 是一个基于 Model Context Protocol（MCP）的服务器，它允许模型访问当前 iTerm 会话，执行命令并提供控制台界面。它支持与 REPL（Read-Eval-Print-Loop）的交互，能够发送控制字符，如 ctrl-c、ctrl-z 等。此项目使用 TypeScript 和 JavaScript 编写，旨在提供高效、易用的终端控制解决方案。

2. 项目快速启动

环境要求

• iTerm2 必须正在运行
• Node 版本 18 或更高

安装步骤

通过 Smithery 自动安装

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

手动安装

1. 将服务器配置添加到 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"
         ]
       }
     }
   }
   

2. 使用 npx 运行 iTerm-MCP：

   npx -y iterm-mcp
   

3. 应用案例和最佳实践

使用 iTerm-MCP 执行命令

你可以通过 iTerm-MCP 发送命令到终端，并获取命令输出的最后几行。以下是一个示例：

import { write_to_terminal } from 'iterm-mcp';

async function executeCommand(command: string): Promise<number> {
  const outputLines = await write_to_terminal(command);
  console.log(`命令输出行数: ${outputLines}`);
  return outputLines;
}

executeCommand('ls -l');

监控和控制会话

你可以读取终端的输出，以监控会话状态或获取信息：

import { read_terminal_output } from 'iterm-mcp';

async function readSessionOutput(lines: number): Promise<string> {
  const output = await read_terminal_output(lines);
  console.log(`终端输出: ${output}`);
  return output;
}

readSessionOutput(5);

发送控制字符

在需要中断或修改会话时，可以发送控制字符：

import { send_control_character } from 'iterm-mcp';

function sendCtrlC(): void {
  send_control_character('ctrl-c');
}

sendCtrlC();

4. 典型生态项目

目前，iTerm-MCP 主要被设计用于与 Claude Desktop 配合使用，但它的应用不限于单一平台。以下是可能构建的生态项目：

• 集成开发环境（IDE）插件：为各种 IDE 提供插件，以便在开发过程中直接与 iTerm-MCP 交互。
• 自动化脚本：构建自动化脚本，利用 iTerm-MCP 执行复杂的自动化任务，如自动化部署、测试等。
• 交互式教学工具：利用 iTerm-MCP 创建交互式终端教学应用，帮助用户学习 shell 脚本和命令行工具。

通过以上介绍，你可以开始探索 iTerm-MCP 的可能性，并在你的项目中利用它来增强终端会话的交互性和控制力。