The full upstream README, mirrored here for reference. Install config, tool schemas, adoption signals, and an original overview live on the MCP Server Terminal listing page.
MCP server enabling AI agents to interact with terminal applications through structured Terminal State Tree representation. Works with any AI assistant that supports the Model Context Protocol.
Download pre-built binaries from Releases.
Add to ~/.claude.json (macOS/Linux) or %APPDATA%\Claude\claude_desktop_config.json (Windows):
Add to ~/.codex/config.toml:
VS Code 1.101+ supports MCP. Add to your VS Code settings (settings.json):
Add to ~/.cursor/mcp.json or .cursor/mcp.json in your project:
Add to ~/.codeium/windsurf/mcp_config.json:
Add to your Zed settings (Preferences → Settings):
Click MCP Servers icon → Configure → Advanced MCP Settings, then add:
Add to your Bedrock agent MCP configuration:
For any MCP-compatible client, configure the server with:
npx["mcp-server-terminal"]Or if using the binary directly:
terminal-mcpAsk your AI agent:
| Tool | Description |
|---|---|
terminal_session_create | Start a terminal session |
terminal_session_list | List active sessions |
terminal_session_close | Close a session |
terminal_session_resize | Resize terminal dimensions |
terminal_snapshot | Capture terminal state with UI elements |
terminal_type | Type text into terminal |
terminal_press_key | Press keys (arrows, F-keys, Ctrl+X) |
terminal_click | Click on detected UI element |
terminal_wait_for | Wait for text, element, or idle state |
terminal_read_output | Read raw terminal output |
By default, sessions spawn a visible terminal window (xterm). For headless operation:
Or in your MCP config:
Visual mode requires X11. Add the DISPLAY environment variable to your MCP config:
Set the RUST_LOG environment variable:
Log levels: error, warn, info, debug, trace
Logs go to stderr (stdout is reserved for MCP protocol).
| Platform | Architecture | Status | Visual Mode |
|---|---|---|---|
| Linux | x64, arm64 | ✅ Full support | xterm + tmux |
| macOS | x64, arm64 | ✅ Full support | Terminal.app / iTerm2 |
| Windows (WSL) | x64, arm64 | ✅ Full support | xterm + tmux (via X11) |
| Windows (native) | x64 | ⚠️ Headless only | Not supported |
Windows users: Use WSL for full functionality including visual mode.
MIT