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

Эта процедура создаёт шифрованный профиль, записывает конфигурацию клиента и запускает первые инструменты. В примере — учётная запись contoso\alice и профиль corp.

1. Соберите или установите сервер

Установите готовый бинарь или соберите проект один раз:

cargo build --release

2. Создайте профиль

Создайте шифрованный профиль. Команда читает пароль без эха и печатает токен профиля ровно один раз:

./target/release/winrig setup corp --user 'DOMAIN\user'

Опасно

Токен профиля расшифровывает профиль. Сохраните его сразу. setup показывает его один раз.

3. Запишите конфигурацию клиента

Либо вставьте напечатанное определение MCP-сервера в клиент вручную, либо дайте setup записать его:

./target/release/winrig setup corp --user 'DOMAIN\user' --write-config opencode --scope global
./target/release/winrig setup corp --user 'DOMAIN\user' --write-config claude-code --scope project

--write-config требует уровень: --scope global для пользовательской конфигурации или --scope project для текущего репозитория. Без флага setup спрашивает в терминале. В неинтерактивном запуске setup отказывает и указывает на --scope.

См. Клиенты для точной конфигурации каждого клиента.

Осторожно

Вторая запись на один профиль поднимает второй процесс. Второй процесс теряет блокировку профиля и выходит, а клиент сообщает лишь MCP error -32000: Connection closed.

4. Запустите сервер

Запустите сервер в одном из двух режимов:

# Локальный stdio-процесс для одного клиента (токен профиля приходит из окружения клиента).
WINRIG_TOKEN='<токен из setup>' ./target/release/winrig stdio --profile corp

# HTTP-сервис на 127.0.0.1:8005/mcp для нескольких проектов.
WINRIG_TOKEN='<токен из setup>' ./target/release/winrig serve --profile corp

Серверу нужен хотя бы один секрет. Он отказывает в старте, если нет ни токена профиля, ни общего секрета.

5. Откройте первую сессию

В клиенте вызовите инструмент connect с именем хоста и учётной записью. Инструмент открывает WinRM-сессию и возвращает session_id. Используйте HTTPS-порт 5986 с use_ssl, когда хоп до хоста должен быть шифрованным.

6. Запустите первый инструмент чтения

Вызовите инструмент только для чтения, например get_system_info или list_directory. Сервер возвращает результат агенту. Инструмент только для чтения не требует подтверждения.

7. Запустите модифицирующую операцию

Вызовите модифицирующий инструмент, например restart_service. Инструмент запрашивает у оператора подтверждение через MCP elicitation. Он запускается только после явного «да». Без канала подтверждения инструмент отказывает (fail-closed).

Заметка

write_file выключен по умолчанию. Задайте WINRIG_ALLOW_FILE_WRITE=true, чтобы сервер объявил его. run_command тоже выключен по умолчанию: задайте WINRIG_ALLOW_COMMAND_EXEC=true, чтобы сервер объявил его. run_script выключен по умолчанию: задайте WINRIG_ALLOW_SCRIPT_EXEC=true, чтобы сервер объявил его. Файловые операции copy_file, move_file, rename_file и create_directory выключены по умолчанию: задайте WINRIG_ALLOW_FILE_OPS=true, чтобы сервер объявил их. См. справочник по инструментам.

Полный список переменных окружения — в справочнике по конфигурации.