3xui-mcp

MCP-сервер (Model Context Protocol) для панели 3x-ui, построенный на 3xui-api-client.

Область действия намеренно ограничена, чтобы сохранить контекст инструментов небольшим: операции чтения плюс полный CRUD для inbounds и клиентов. Узлы, группы, гео-файлы, резервные копии, конфигурация Xray и настройки панели выходят за рамки — расширьте src/tools/, если они вам нужны.

Инструменты

Related MCP server: Open WebUI MCP Server

Конфигурация

Задайте учетные данные через переменные окружения — выберите один режим аутентификации:

# 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

Сборка и запуск

npm install
npm run build
npm start

Использование с MCP-клиентом

Добавьте в конфигурацию MCP вашего клиента (например, 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"
      }
    }
  }
}

После публикации в npm command/args можно заменить на "npx" / ["-y", "3xui-mcp"].

Локальное тестирование

npm run inspector

Открывает MCP Inspector для этого сервера.

Навык агента

skills/3xui-mcp/SKILL.md описывает обязательные/необязательные поля каждого инструмента, единицы измерения (ГБ против байт, временные метки в мс) и типовые рабочие процессы для ИИ-агента, управляющего этим сервером — загрузите его вместе с сервером, чтобы агенту не приходилось угадывать форматы входных данных только по описаниям инструментов.