iterm-mcp

iterm-mcp

A Model Context Protocol server that provides access to your iTerm session.

Features

Efficient Token Use: iterm-mcp gives the model the ability to inspect only the output that the model is interested in. The model typically only wants to see the last few lines of output even for long running commands.

Natural Integration: You share iTerm with the model. You can ask questions about what's on the screen, or delegate a task to the model and watch as it performs each step.

Full Terminal Control and REPL support: The model can start and interact with REPL's as well as send control characters like ctrl-c, ctrl-z, etc.

Easy on the Dependencies: iterm-mcp is built with minimal dependencies and is designed to be easy to add to Claude Desktop and other MCP clients. It should just work.

Safety Considerations

• The user is responsible for using the tool safely.
• No built-in restrictions: iterm-mcp makes no attempt to evaluate the safety of commands that are executed.
• Models can behave in unexpected ways. The user is expected to monitor activity and abort when appropriate.
• For multi-step tasks, you may need to interrupt the model if it goes off track. Start with smaller, focused tasks until you're familiar with how the model behaves.

Tools

• write_to_terminal - Writes to the active iTerm terminal, often used to run a command. Returns the number of lines of output produced by the command.
• read_terminal_output - Reads the requested number of lines from the active iTerm terminal.
• send_control_character - Sends a control character to the active iTerm terminal.

Requirements

• iTerm2 must be running
• Node version 18 or greater

Installation

1. Clone the Repository:

   git clone https://github.com/pashpashpash/iterm-mcp.git
   cd iterm-mcp
   

2. Install Dependencies:

   yarn install
   

3. Build the Project:

   yarn run build
   

4. Configure Claude Desktop:

Add the server config to:

• On macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
• On Windows: %APPDATA%/Claude/claude_desktop_config.json

{
  "mcpServers": {
    "iterm-mcp": {
      "command": "node",
      "args": ["path/to/build/index.js"]
    }
  }
}

Note: Replace "path/to/build/index.js" with the actual path to your built index.js file.

Development

For development with auto-rebuild:

yarn run watch

Debugging

Since MCP servers communicate over stdio, debugging can be challenging. We recommend using the MCP Inspector:

cd path/to/iterm-mcp
yarn run inspector
yarn debug <command>

The Inspector will provide a URL to access debugging tools in your browser.

View logs with:

tail -n 20 -f ~/Library/Logs/Claude/mcp*.log

License

Licensed under MIT - see LICENSE file.

Note: This is a fork of the original iterm-mcp repository.