3xui-mcp

Servidor MCP (Model Context Protocol) para el panel 3x-ui, construido sobre 3xui-api-client.

Alcance intencionalmente limitado para mantener el contexto de las herramientas pequeño: operaciones de lectura más CRUD completo para inbounds y clientes. Los nodos, grupos, archivos geo, copias de seguridad, configuración de Xray y ajustes del panel están fuera del alcance: amplía src/tools/ si los necesitas.

Herramientas

Related MCP server: Open WebUI MCP Server

Configuración

Configura las credenciales mediante variables de entorno: elige un modo de autenticación:

# 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

Compilar y ejecutar

npm install
npm run build
npm start

Uso con un cliente MCP

Añade a la configuración MCP de tu cliente (por ejemplo, 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"
      }
    }
  }
}

Una vez publicado en npm, command/args se pueden reemplazar con "npx" / ["-y", "3xui-mcp"].

Probar localmente

npm run inspector

Abre el MCP Inspector contra este servidor.

Habilidad del agente

skills/3xui-mcp/SKILL.md documenta los campos obligatorios/opcionales de cada herramienta, las unidades (GB frente a bytes, marcas de tiempo en ms) y los flujos de trabajo comunes para un agente de IA que maneja este servidor: cárgalo junto con el servidor para que el agente no tenga que adivinar las formas de entrada solo a partir de las descripciones de las herramientas.