iterm_mcp_server/README.md

A Model Context Protocol (MCP) server implementation for iTerm2 terminal integration

# 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:

```json
{
  "mcpServers": {
    "terminal": {
      "command": "npx",
      "args": ["iterm_mcp_server"],
      "env": {
        "SHELL": "/bin/zsh",
      }
    }
  }
}
```

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