iTerm MCP Server

What is iTerm-MCP-Server?

iTerm-MCP-Server is a Model Context Protocol (MCP) server implementation designed for integration with iTerm2, a popular terminal emulator for macOS. It enables AI assistants to interact with iTerm2 terminals programmatically.

How to use iTerm-MCP-Server?

To use iTerm-MCP-Server, you need Node.js (>= 14.x), iTerm2, and macOS. The server uses standard MCP configuration options. For integration with Cursor, you need to add a specific configuration to your ~/.cursor/mcp.json file, specifying npx as the command and iterm_mcp_server as the argument.

Key Features of iTerm-MCP-Server

• Terminal Session Management: Create, manage, and close iTerm2 terminal sessions.
• Command Execution: Execute commands within specific terminals.
• Output Reading: Read the output generated by terminal commands.
• Active Terminal Listing: List all currently active terminals and their associated information.
• Security: Input validation using Zod schemas, command execution in isolated sessions, and robust error handling with input sanitization.

Use Cases of iTerm-MCP-Server

• AI Assistant Integration: Allows AI assistants to directly control and interact with iTerm2 terminals, automating tasks and providing contextual information.
• Automated Workflows: Facilitates the creation of automated workflows that involve terminal operations.
• Development Tools: Serves as a backend for development tools that require terminal interaction.

FAQ from iTerm-MCP-Server

Q: What are the system requirements? A: Node.js >= 14.x, iTerm2, and macOS.

Q: How do I configure it for use with Cursor? A: Add the provided JSON configuration to your ~/.cursor/mcp.json file.

Q: Is it secure? A: Yes, it includes input validation, isolated command execution, and proper error handling.

ITerm MCP Server

A Model Context Protocol (MCP) server implementation for iTerm2 terminal integration. This server allows AI assistants to interact with iTerm2 terminals through the Model Context Protocol.

Features

• Create and manage iTerm2 terminal sessions
• Execute commands in terminals
• Read terminal output
• List active terminals
• Close terminals

Requirements

• Node.js >= 14.x
• iTerm2
• macOS (since iTerm2 is macOS-only)

Configuration

Standard Configuration

The server uses the standard MCP configuration options. No additional configuration is required.

Cursor Configuration

To use this server with Cursor, add the following configuration to your ~/.cursor/mcp.json file:

{
  "mcpServers": {
    "terminal": {
      "command": "npx",
      "args": ["iterm_mcp_server"]
    }
  }
}

Tools

• open_terminal: Open a new terminal instance
• execute_command: Execute a command in a specific terminal
• read_output: Read the output from a specific terminal
• close_terminal: Close a specific terminal
• list_terminals: List all active terminals and their information

Security Considerations

• The server validates all input using Zod schemas
• Commands are executed in isolated terminal sessions
• Proper error handling and input sanitization is implemented

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

ISC

Author

Rishab Koul