gmod-mcp
v1.0.1
Published
MCP tool for interacting with Garry's Mod server via RCON and Lua code execution
Maintainers
Readme
GMod MCP Tool
MCP (Model Context Protocol) tool для взаимодействия с сервером Garry's Mod через RCON.
Возможности
- Подключение к серверу: Подключение к GMod серверу через RCON
- Выполнение RCON команд: Отправка любых RCON команд на сервер
- Выполнение Lua кода: Выполнение Lua кода на сервере через команду
lua_run
Установка
Через npm (рекомендуется)
npm install -g gmod-mcpИли локально в проект:
npm install gmod-mcpИз исходников
- Клонируйте репозиторий или скачайте проект
- Установите зависимости:
npm install- Убедитесь, что на вашем GMod сервере включен RCON:
- В файле
server.cfgилиautoexec.cfgдобавьте:
rcon_password "ваш_пароль" - В файле
Использование
Настройка в Cursor/Claude Desktop
Добавьте в конфигурацию MCP (обычно ~/.cursor/mcp.json или аналогичный файл):
Использование через npx (рекомендуется):
{
"mcpServers": {
"gmod": {
"command": "npx",
"args": ["-y", "gmod-mcp"]
}
}
}Или после локальной установки:
{
"mcpServers": {
"gmod": {
"command": "node",
"args": ["node_modules/gmod-mcp/src/index.js"]
}
}
}Примечание: Использование
npxс флагом-yавтоматически установит пакет при первом использовании, если он не установлен. Пример конфигурации находится в файлеmcp-config-example.json.
Доступные инструменты
1. gmod_connect
Подключиться к серверу GMod через RCON.
Параметры:
host(обязательно): IP адрес или хост сервераport(опционально): RCON порт (по умолчанию 27015)password(обязательно): RCON пароль
2. gmod_execute_rcon
Выполнить RCON команду на сервере.
Параметры:
command(обязательно): RCON команда для выполнения
Примеры команд:
status- получить статус сервераsay Привет всем!- отправить сообщение в чатkick PlayerName- кикнуть игрока
3. gmod_execute_lua
Выполнить Lua код на сервере.
Параметры:
code(обязательно): Lua код для выполнения
Примеры:
print("Hello from RCON!")
for k, v in pairs(player.GetAll()) do
print(v:Nick())
end4. gmod_disconnect
Отключиться от сервера.
Примеры использования
Подключение и выполнение команды
- Сначала подключитесь:
gmod_connectс параметрамиhost,port,password - Затем выполните команду:
gmod_execute_rconс параметромcommand
Выполнение Lua кода
- Подключитесь через
gmod_connect - Выполните Lua код через
gmod_execute_luaс параметромcode
Требования
- Node.js 18+
- Garry's Mod сервер с включенным RCON
- Знание RCON пароля сервера
Примечания
- RCON должен быть включен на сервере
- Убедитесь, что порт RCON открыт в файрволе
- Lua код выполняется на стороне сервера
- Некоторые команды могут требовать админских прав
- Подключение автоматически переподключается при необходимости
- Для выполнения Lua кода используется команда
lua_run, которая доступна только на серверной стороне
Устранение неполадок
Ошибка подключения
- Проверьте, что сервер запущен и доступен
- Убедитесь, что RCON пароль правильный
- Проверьте, что порт не заблокирован файрволом
Ошибка выполнения команды
- Убедитесь, что вы подключены к серверу (
gmod_connect) - Проверьте синтаксис команды
- Некоторые команды могут требовать специальных прав
Lua код не выполняется
- Убедитесь, что используете правильный синтаксис Lua
- Проверьте, что код не содержит синтаксических ошибок
- Некоторые функции могут быть недоступны в зависимости от конфигурации сервера
- Важно: Многострочный Lua код нужно писать в одну строку с точками с запятой (
;) или использовать простые однострочные команды - Пример многострочного кода в одну строку:
local players = player.GetAll(); for k, v in pairs(players) do print(v:Nick()) end
Лицензия
MIT
