NanoKVM

Exposes NanoKVM controls as MCP tools for remote power, input, screens, and ISO operations.

python

5

GitHub Stars

python

Language

4 months ago

First Indexed

2 months ago

Catalog Refreshed

Documentation & install

Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.

Installation

Add the following to your MCP client configuration file.

Configuration

View docs

{
  "mcpServers": {
    "scgreenhalgh-nanokvm-mcp": {
      "command": "python",
      "args": [
        "-m",
        "nanokvm_mcp.server"
      ],
      "env": {
        "NANOKVM_HOST": "<HOST_ADDRESS>",
        "NANOKVM_PASS": "admin",
        "NANOKVM_USER": "admin",
        "NANOKVM_SCREEN_WIDTH": "1920",
        "NANOKVM_SCREEN_HEIGHT": "1080"
      }
    }
  }
}

You run a server that exposes NanoKVM controls to MCP clients, letting AI assistants remotely power, control input, capture screenshots, and manage ISO images on NanoKVM hardware. This MCP server acts as the bridge between an AI assistant and the NanoKVM device, enabling practical, hands-off management of remote systems.

How to use

Once you have the MCP server running, you can interact with it from an MCP client like Claude. The server exposes tools to power the device, send keyboard and mouse input, capture screenshots, manage ISO images, and read hardware status. Use each tool by calling its corresponding MCP endpoint through your client, providing the required parameters as described in the tool definitions.

How to install

Prerequisites: you need Python 3.10 or newer and a working Python environment to install and run the MCP server.

Step 1: Clone the MCP server repository.

git clone https://github.com/scgreenhalgh/nanokvm-mcp.git
cd nanokvm-mcp

Step 2: Install the package in editable mode to satisfy dependencies.

pip install -e .

Additional configuration and running tips

You run the MCP server as a Python module. The following command starts the server and connects it to a NanoKVM at a given host, using the credentials and screen dimensions you specify.

python -m nanokvm_mcp.server

Available tools

nanokvm_power

Control power: power, power_long (force off), reset for hardware reset

nanokvm_led_status

Query power and HDD LED states

nanokvm_hdmi_status

Get HDMI connection state and current resolution

nanokvm_hdmi_reset

Reset the HDMI connection

nanokvm_screenshot

Capture and return a screenshot as a JPEG

nanokvm_send_text

Type text input on the remote machine with optional language support

nanokvm_send_key

Send a single key event with optional modifiers (ctrl, shift, alt, meta)

nanokvm_tap

Tap the screen at absolute coordinates

nanokvm_click

Click mouse button at absolute coordinates

nanokvm_move

Move the cursor to a given position

nanokvm_scroll

Scroll the mouse wheel by a numeric amount

nanokvm_list_images

List available ISO images

nanokvm_mount_iso

Mount an ISO image for remote OS installation

nanokvm_unmount_iso

Unmount the current ISO image

nanokvm_mounted_image

Get information about the mounted image

nanokvm_reset_hid

Reset keyboard and mouse devices

nanokvm_info

Get NanoKVM device information

nanokvm_hardware

Get hardware information