Skip to main content

MCP Server providing fully interactive terminal sessions for AI agents - TUI support, keyboard control, screen capture - Cross-platform (Windows, Linux, Mac)

Project description

🖥️ Interactive Terminal MCP Server

PyPI version License: MIT

A fully interactive terminal MCP server for AI agents with TUI support, keyboard control, and screen capture - Cross-platform (Windows, Linux, Mac).

✨ Features

  • 🖥️ Full Terminal Control - Create, manage, and delete terminal sessions
  • ⌨️ Keyboard Support - Arrow keys, Ctrl, Alt, F-keys, PageUp/Down, etc.
  • 📺 TUI Applications - Works with htop, vim, nano, mc, and more
  • 🔄 Auto-Update - Automatically checks and installs updates from PyPI
  • 🌍 Cross-Platform - Windows (pywinpty), Linux/Mac (ptyprocess)

📦 Installation

pip install vitjas-interactive-terminal

🚀 Usage

Start the MCP Server

You can start the server in 3 ways:

# Option 1: Entry Point (recommended)
vitjas-interactive-terminal

# Option 2: Python Module
python -m interactive_terminal

# Option 3: Python3 Module (Linux/Mac)
python3 -m interactive_terminal

MCP Configuration

For Claude Desktop / Agent Zero:

Linux/Mac (Option A - Entry Point):

{
  "mcpServers": {
    "InteractiveTerminal": {
      "command": "vitjas-interactive-terminal",
      "args": [],
      "init_timeout": 30
    }
  }
}

Linux/Mac (Option B - Python3 Module):

{
  "mcpServers": {
    "InteractiveTerminal": {
      "command": "python3",
      "args": ["-m", "interactive_terminal"],
      "init_timeout": 30
    }
  }
}

Windows:

{
  "mcpServers": {
    "InteractiveTerminal": {
      "command": "python",
      "args": ["-m", "interactive_terminal"],
      "init_timeout": 30
    }
  }
}

🛠️ Available Tools

Tool Description
create_terminal Create a new interactive terminal session
send_text Send text/commands to a terminal
send_keys Send special keys (arrows, Ctrl+C, etc.)
get_screen Read terminal screen content
list_terminals List all active terminals
delete_terminal Delete/close a terminal
search_buffer Search through terminal history

⌨️ Supported Keys

  • Navigation: up, down, left, right, home, end, pageup, pagedown
  • Control: ctrl+c, ctrl+d, ctrl+z, ctrl+a, ctrl+e, ctrl+u, ctrl+k, ctrl+w, ctrl+l
  • Alt: alt+f, alt+b, alt+d
  • Other: enter, escape, tab, backspace, delete, f1-f12

💡 Examples

Navigate htop:

# Create terminal and start htop
create_terminal  send_text("htop\n")  get_screen()
# Navigate with arrow keys
send_keys("down")  send_keys("enter")
# Exit
send_keys("f10") or send_keys("q")

Edit with nano:

# Create and open file
create_terminal  send_text("nano test.txt\n")
# Type content
send_text("Hello World!")
# Save and exit
send_keys("ctrl+x")  send_text("Y")  send_keys("enter")

🔧 Configuration

Disable Auto-Update:

VITJAS_AUTO_UPDATE=false vitjas-interactive-terminal

📋 Requirements

  • Python >= 3.10
  • Windows: pywinpty >= 2.0.0 (auto-installed)
  • Linux/Mac: ptyprocess >= 0.7.0 (auto-installed)

🔗 Links

📜 License

MIT License - see LICENSE

👤 Author

Vltja - GitHub

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vitjas_interactive_terminal-1.2.3.tar.gz (13.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

vitjas_interactive_terminal-1.2.3-py3-none-any.whl (12.5 kB view details)

Uploaded Python 3

File details

Details for the file vitjas_interactive_terminal-1.2.3.tar.gz.

File metadata

File hashes

Hashes for vitjas_interactive_terminal-1.2.3.tar.gz
Algorithm Hash digest
SHA256 bb8d446f7a122245f4ed266ff9b8c557847d4da18f9f364d55fd3bd684e9200c
MD5 fca69c31caaab6f7ef56be0998552e4e
BLAKE2b-256 ba9fec984a20fccadf21d694514da92f142d61ea2aaeb50b0289619362ac08f3

See more details on using hashes here.

File details

Details for the file vitjas_interactive_terminal-1.2.3-py3-none-any.whl.

File metadata

File hashes

Hashes for vitjas_interactive_terminal-1.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 e7c5070a149b22afd90f28827d04c1d700e96cc9b15f601dac6b99fae665eeea
MD5 ecea784e425f28f9503bc3f4abe5a3bc
BLAKE2b-256 ca60aa8185e0d35ed676e9402974fba43a97b4f31009f063db8c3e66bdaa5df6

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page