About iterm-mcp
iterm-mcp is an MCP server that gives models access to the current iTerm session, allowing them to run commands and read output. It is intended for REPL and command line assistance, where the user and the model share one terminal.
Key features
- 01Writes commands to the active iTerm terminal
- 02Reads a requested number of output lines
- 03Sends control characters such as ctrl-c
- 04Starts and interacts with REPL sessions
- 05Runs through npx with minimal dependencies
Use cases
- 01Letting a model run steps in a REPL while the user watches
- 02Reading only the last lines of a long-running command
- 03Assisting command line work from Claude Desktop
MCP support
This is an MCP server that exposes the write_to_terminal, read_terminal_output and send_control_character tools to MCP clients.
Configuration
Local server config is the same for every client. Copy it into your client’s MCP config file.
Tools
3Saved tool list · updated 3w ago
| Parameter | Type | Required | Description |
|---|---|---|---|
| command | string | Yes | The command to run or text to write to the terminal |
Details
From the project READMEiterm-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 runnable via npx. It's 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
To use with Claude Desktop, add the server config:
On macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
On Windows: %APPDATA%/Claude/claude_desktop_config.json
{
"mcpServers": {
"iterm-mcp": {
"command": "npx",
"args": [
"-y",
"iterm-mcp"
]
}
}
}
Installing via Smithery
To install iTerm for Claude Desktop automatically via Smithery:
npx -y @smithery/cli install iterm-mcp --client claude
Development
Install dependencies:
yarn install
Build the server:
yarn run build
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, which is available as a package script:
yarn run inspector
yarn debug <command>
The Inspector will provide a URL to access debugging tools in your browser.
Comments
New to MCP?
From what the protocol is to installing your first server, these answers cover most first questions.
An open protocol that defines how AI applications connect to external tools and data in a uniform way. Clients talk to the model; MCP servers provide tools, resources and prompt templates. They exchange standard messages, so one server can be reused by many clients.