3xui-mcp

MCP (Model Context Protocol) Server für das 3x-ui Panel, basierend auf 3xui-api-client.

Bewusst eingeschränkt, um den Tool-Kontext klein zu halten: Leseoperationen plus vollständiges CRUD für Inbounds und Clients. Nodes, Gruppen, Geo-Dateien, Backups, Xray-Konfiguration und Panel-Einstellungen sind nicht im Umfang enthalten – erweitere src/tools/, falls du sie benötigst.

Tools

Related MCP server: Open WebUI MCP Server

Konfiguration

Lege Anmeldedaten über Umgebungsvariablen fest – wähle einen Authentifizierungsmodus:

# Required
THREEXUI_BASE_URL=https://your-panel.example.com

# Cookie auth (admin username/password)
THREEXUI_USERNAME=admin
THREEXUI_PASSWORD=your-password

# OR API token auth (skips username/password)
THREEXUI_API_TOKEN=your-token

# Optional, default "auto"
THREEXUI_PANEL_TYPE=auto   # auto | modern | legacy

Build & Ausführen

npm install
npm run build
npm start

Verwendung mit einem MCP-Client

Füge die folgende Konfiguration zur MCP-Konfiguration deines Clients hinzu (z. B. Claude Desktop claude_desktop_config.json):

{
  "mcpServers": {
    "3xui": {
      "command": "node",
      "args": ["/absolute/path/to/3xui-mcp/dist/index.js"],
      "env": {
        "THREEXUI_BASE_URL": "https://your-panel.example.com",
        "THREEXUI_USERNAME": "admin",
        "THREEXUI_PASSWORD": "your-password"
      }
    }
  }
}

Sobald das Paket auf npm veröffentlicht ist, können command/args durch "npx" / ["-y", "3xui-mcp"] ersetzt werden.

Lokal testen

npm run inspector

Öffnet den MCP Inspector für diesen Server.

Agent-Fähigkeit

skills/3xui-mcp/SKILL.md dokumentiert die Pflicht-/Optionalfelder jedes Tools, Einheiten (GB vs. Bytes, ms-Zeitstempel) und gängige Arbeitsabläufe für einen KI-Agenten, der diesen Server steuert – lade es zusammen mit dem Server, damit der Agent nicht allein anhand der Tool-Beschreibungen die Eingabeformate erraten muss.