Files
omnichannel-configserver-mcp/docs/getting-started.md
T

4.1 KiB

Быстрый старт

omnichannel-configserver-mcp — это MCP-сервер: программа, которую AI-ассистент (Claude Desktop, Cursor, Continue и любой другой MCP-клиент) запускает как локальный процесс и через которую получает доступ к платформе Omnichannel. Сервер не хранит состояние и не имеет UI: он лишь транслирует запросы агента в HTTP API config_server.

Что понадобится

  1. Запущенный config_server (версия 1.1.0 или новее), доступный по сети. По умолчанию — http://<host>:5005. Проверить: curl http://<host>:5005/health → OK.
  2. Учётная запись config_server (логин/пароль администратора).
  3. MCP-клиент, поддерживающий stdio-серверы (Claude Desktop, Cursor и др.).
  4. Для сборки — Go 1.27+ и доступ к общему тулкиту (Go-модуль forge-toolkit на git.totmin.ru; задайте GOPRIVATE=git.totmin.ru).

1. Сборка

cd omnichannel-configserver-mcp
export GOPRIVATE=git.totmin.ru
go build -o omnichannel-configserver-mcp .
./omnichannel-configserver-mcp --health          # -> ok

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

Скопируйте пример и задайте адрес и креды:

cp examples/config.single-server.json config.json
{
  "servers": [
    {
      "alias": "prod",
      "base_url": "http://10.20.30.40:5005",
      "username": "${OMNI_USER}",
      "password": "${OMNI_PASSWORD}"
    }
  ],
  "default": "prod",
  "read_only": false
}

Секреты удобно держать в переменных окружения или в config.local.json (подробно — configuration.md).

Проверьте конфиг (секреты маскируются) — это самая частая причина проблем:

export OMNI_USER=admin OMNI_PASSWORD='...'
./omnichannel-configserver-mcp --check-config -config config.json

3. Подключение к MCP-клиенту

Общий вид конфигурации (для любого клиента, поддерживающего mcpServers):

{
  "mcpServers": {
    "omnichannel-configserver-mcp": {
      "command": "/opt/omnichannel-configserver-mcp/omnichannel-configserver-mcp",
      "args": ["-config", "/opt/omnichannel-configserver-mcp/config.json"],
      "env": {
        "OMNI_USER": "admin",
        "OMNI_PASSWORD": "СЕКРЕТ"
      }
    }
  }
}

Готовые сниппеты для конкретных клиентов — mcp-clients.md.

4. Проверка

Попросите ассистента:

«Проверь подключение к Omnichannel и покажи, что сейчас на стенде.»

Ассистент вызовет server_info (версия API и режим), затем overview (сводка). Если видите корректную версию 1.1.0 и список сервисов — всё работает.

5. Первый деплой

Самый быстрый сценарий для уже зарегистрированного сервиса:

«Обнови compose сервиса demo_web на образ nginx:1.27, подними его и дождись результата.»

Последовательность вызовов и подробные сценарии (1 сервер, N серверов, фронт, откат) — deployment.md. Готовые промпты — ../examples/prompts.md.

Демо-стенд (без прода)

Поднять локальный config_server и прогнать сквозной пример:

docker compose -f examples/demo/docker-compose.yml up -d
go build -o omnichannel-configserver-mcp .
python3 examples/demo/demo.py