iterm-mcp logo

iterm-mcp

by ferrislucas

iterm-mcp is a Model Context Protocol server that provides access to your iTerm session. It allows models to interact with and control your iTerm terminal.

View on GitHub

Last updated: N/A

What is iterm-mcp?

iterm-mcp is a server that enables language models to interact with and control your iTerm2 terminal. It leverages the Model Context Protocol (MCP) to allow models to execute commands, read output, and send control characters.

How to use iterm-mcp?

To use iterm-mcp, you need to configure your MCP client (e.g., Claude Desktop) to connect to the server. This typically involves adding a server configuration with the command npx -y iterm-mcp. You can also install it via Smithery. Once configured, the model can use the provided tools to interact with the terminal.

Key features of iterm-mcp

  • Efficient Token Use

  • Natural Integration

  • Full Terminal Control and REPL support

  • Easy on the Dependencies

Use cases of iterm-mcp

  • Asking questions about what's on the screen

  • Delegating tasks to the model and watching it perform each step

  • Interacting with REPL environments

  • Automating terminal-based workflows

FAQ from iterm-mcp

What is MCP?

Model Context Protocol

What iTerm2 version is required?

iTerm2 must be running

What Node version is required?

Node version 18 or greater

How do I install iterm-mcp?

You can install iterm-mcp using npx or Smithery. See the installation section in the README.

How do I debug iterm-mcp?

Use the MCP Inspector via yarn run inspector and yarn debug <command>.