iTerm

by ferrislucas

458 stars
17.5k downloads
Not rated
GitHub Website

About

Enables direct execution of shell commands in the active iTerm tab, streamlining terminal-based workflows and automation tasks.

Details

Author
ferrislucas
Repository
ferrislucas/iterm-mcp
GitHub stars
458
Downloads
17,535
License
MIT License
Categories
Productivity, Other, Design, Developer Tools, AI, Frontend, Project Management

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.

Setting up with Highlight

This MCP is not yet compatible with Highlight’s one-click setup. However, you can still use it with Highlight by following these steps:

  1. Download and install Highlight from highlightai.com/download
  2. Navigate to the plugins tab and select "Add Custom Plugin"
  3. Configure the plugin with the settings below
    Plugin Name iTerm
    Command (node, npx, python, etc.) npx
    Arguments
    • Argument 1 -y
    • Argument 2 iterm-mcp

    Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.

  4. Enable "Start Automatically" if you want the plugin to start when Highlight launches

From the repository

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"
      ]
    }
  }
}

To install iTerm for Claude Desktop automatically via Smithery:

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

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.

- 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.

Claude Desktop / Cursor

Paste into your MCP client config file to install this server.

{
    "mcpServers": {
        "iterm": {
            "cwd": "string",
            "env": {},
            "args": [
                "-y",
                "iterm-mcp"
            ],
            "shell": false,
            "command": "npx"
        }
    }
}

Linux

{
    "cwd": "string",
    "env": [],
    "args": [
        "-y",
        "iterm-mcp"
    ],
    "shell": false,
    "command": "npx"
}

Macos

{
    "cwd": "string",
    "env": [],
    "args": [
        "-y",
        "iterm-mcp"
    ],
    "shell": false,
    "command": "npx"
}

Windows

{
    "cwd": "string",
    "env": [],
    "args": [
        "-y",
        "iterm-mcp"
    ],
    "shell": false,
    "command": "npx"
}
A Model Context Protocol server that provides access to your iTerm session. **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. - 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. - `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. - iTerm2 must be running - Node version 18 or greater 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" ] } } }` ``` To install iTerm for Claude Desktop automatically via[Smithery: ``` `npx -y @smithery/cli install iterm-mcp --client claude` ``` Since MCP servers communicate over stdio, debugging can be challenging. We recommend using the](https://smithery.ai/server/iterm-mcp)[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. Enables LLM clients to interact with macOS applications through AppleScript. Built using the @beyondbetter/bb-mcp-server library, this server provides safe, controlled execution of predefined scripts with optional support for arbitrary script execution. On-device tools to detect AI-generated text and images, score readability, and strip AI artifacts, running locally on Apple silicon. Interact with Apple Notes using natural language on macOS. Free local MCP server for Apple Mail, Calendar, and Reminders on macOS. A server for native integration with Apple Reminders on macOS. Execute AppleScript to gain full control of your Mac. Native macOS Calendar & Reminders MCP server with 24 tools using Swift EventKit - supports recurring events, location triggers, search, batch operations Native macOS Calendar & Reminders MCP server via Apple EventKit — events, reminders, recurrence, location triggers, conflict checks, and batch ops across iCloud/Google/Exchange. An MCP server for integrating with the Claude Desktop application on macOS. Requires the Claude Desktop app to be installed and configured.](https://github.com/modelcontextprotocol/inspector)
No reviews yet — be the first

Sign in to leave a review

Use Google, GitHub, or an email account so ratings stay tied to real people.

Email sign in

No reviews posted yet.