MCP Tunnel

🚀 MCP Tunnel Server

A simple MCP (Model Context Protocol) server that allows access to the command - line interface of a VM machine via MCP. When started, it automatically creates a tunnel, enabling the VM to be accessed from the web.

🚀 Quick Start

A simple MCP (Model Context Protocol) server that allows access to the command - line interface of a VM machine via MCP. When started, it automatically creates a tunnel, enabling the VM to be accessed from the web.

✨ Features

• Execute shell commands on the VM.
• Interact with the VM through a web - based terminal interface.
• Automatic tunneling feature, allowing the VM to be accessed from anywhere.
• Real - time WebSocket communication.

📦 Installation

Prerequisites

• Node.js (v18 or higher)

Installation and Usage

Using npx (No installation required)

npx mcp-cli

Global Installation

npm install -g mcp-cli
mcp-cli

Local Development

# Clone the repository
git clone [repository URL]
cd mcp-cli

# Install dependencies
npm install

💻 Usage Examples

Development

Run the development server with hot - reloading, updating both the front - end and back - end:

npm run dev

Building

Build the front - end and back - end for production:

npm run build-all

Usage

1. Start the MCP server:

# Start with automatic tunneling
npm start

# Start without automatic tunneling
npm start -- --no-tunnel

This will build the project and start the server. By default, a tunnel is created. Use the --no-tunnel flag to disable automatic tunneling.

2. After the server starts, it will provide output on stderr (to avoid interfering with the stdout of MCP communication).

3. Use MCP tools to interact with the server:

Available MCP Tools

• execute_command: Execute a shell command on the VM.
  • Parameters: { "command": "your shell command" }
• start_tunnel: Create a web tunnel to access the VM interface.
  • Parameters: { "port": 8080, "subdomain": "optional-subdomain" }

Web Interface

After starting the tunnel, you can access the web - based terminal interface at the provided URL. This interface allows you to:

• Execute commands directly on the VM.
• View command output in real - time.
• Interact with the VM using any web - enabled device.

Environment Variables

Create a .env file to configure the server:

# Server configuration
PORT=8080

# Localtunnel configuration
LOCALTUNNEL_SUBDOMAIN=your-preferred-subdomain

📚 Documentation

Security Considerations

This tool provides direct access to the VM command line. Consider the following security practices:

• Use strong authentication mechanisms before exposing the tunnel.
• Limit the commands that can be executed through appropriate authentication.
• Consider running in a restricted environment.
• Do not expose sensitive information through the tunnel.