Nmstate MCP

🚀 Nmstate MCP

An MCP server that applies network configuration with nmstate, aiming to simplify network management with the power of LLMs and MCP.

!! WORK IN PROGRESS !!

The vision of this project is to make network management easier by leveraging the capabilities of LLMs and MCP. We welcome you to submit issues with your ideas :)

Please note that the current code is just a prototype and might need to be rewritten with more careful consideration.

🚀 Quick Start

✨ Features

• Applies network configuration using nmstate.
• Potentially simplifies network management with LLMs and MCP.

📦 Installation

From DNF Copr

Here are the steps to set up and run the project from the dnf package manager.

Install from Copr repo: rrajesh/nmstate-mcp

sudo dnf copr enable rrajesh/nmstate-mcp
sudo dnf install nmstate-mcp

Run the setup script

nmstate-mcp-setup

Currently, this corresponds to setup_cursor.py and only supports the Cursor IDE.

Setup inventory.yaml

Configure ~/.nmstate-mcp/inventory.yaml to include the remote hosts you want to configure. nmstate-mcp uses Ansible for remote host configuration.

From Source

The following are the steps to set up and run the project from source.

Install libnmstate

sudo dnf install python3-libnmstate uv

Create venv with system site packages to use libnmstate

uv venv --system-site-packages .venv

source .venv/bin/activate

Download dependencies

uv sync

💻 Usage Examples

Basic Usage

Command to run the server

uv run --directory <path to project directory> main.py

Or, if you are in the project directory:

uv run main.py

You don't need to manually activate the Python virtual environment when using this command.

Configure the MCP client

Claude Desktop, Cursor, and potentially other applications support the "mcpServers" format:

{
  "mcpServers": {
    "nmstate-mcp": {
      "command": "uv",
      "args": [
        "run",
        "--directory",
        "<PATH TO YOUR PROJECT>",
        "main.py"
      ]
    },
  }
}

Advanced Usage

For MCP SuperAssistant: Run the proxy server

This will also run the nmstate mcp server implementation. Refer to mcpconfig.json and edit it according to your directory setup. UV run documentation: docs.astral.sh/uv/reference/cli/#uv-run

npx @srbhptl39/mcp-superassistant-proxy@latest --config ./mcpconfig.json

🔧 Technical Details

Remote Host Configuration

Pre-requisites:

• Ansible.
• SSH.
• For demonstration purposes, you can enable passwordless sudo in the VM or find another authentication method. You won't get a password prompt through Cursor.

📄 License

No license information provided in the original document.