Unity MCP Server

中文 | English

Плагин для Unity Editor, предоставляющий возможности Unity Editor внешним AI-агентам через MCP (Model Context Protocol).

Агенты (такие как Kiro, Cursor, Claude Desktop) могут подключаться к Unity Editor через стандартный протокол MCP для вызова функций редактора.

Характеристики

• Потоковая передача по HTTP — на основе спецификации MCP от 2025-03-26, единая HTTP-точка доступа

• Работа внутри процесса — не требует внешних процессов Node.js/Python, запускается непосредственно внутри редактора

• Расширяемая система инструментов — реализуйте интерфейс IMcpTool для регистрации новых инструментов без изменения основного кода

• Автоматическое восстановление при Domain Reload — служба автоматически перезапускается после входа/выхода из PlayMode

Встроенные инструменты

Установка

Установка через Git URL (рекомендуется)

1. Unity Editor → Window → Package Manager → + → Add package from git URL

2. Введите следующий URL:

https://github.com/yangfch3/Unity-MCP-Server.git

Или отредактируйте файл Packages/manifest.json в проекте:

{
  "dependencies": {
    "com.yangfch3.unity-mcp": "https://github.com/yangfch3/Unity-MCP-Server.git"
  }
}

Установка из локальной папки

1. Клонируйте этот репозиторий

2. Unity Editor → Window → Package Manager → + → Add package from disk

3. Выберите файл package.json в корневой папке репозитория

Или добавьте в Packages/manifest.json:

{
  "dependencies": {
    "com.yangfch3.unity-mcp": "file:../../path/to/unity-mcp"
  }
}

Обновление версии

После установки UPM через Git URL текущий commit hash фиксируется в файле packages-lock.json проекта. В дальнейшем автоматическое обновление не происходит.

Чтобы зафиксировать определенную версию, можно добавить Git Tag в конце URL:

https://github.com/yangfch3/Unity-MCP-Server.git#v0.1.0

Конфигурация для Packages/manifest.json:

{
  "dependencies": {
    "com.yangfch3.unity-mcp": "https://github.com/yangfch3/Unity-MCP-Server.git#v0.1.0"
  }
}

Если тег не указан, отслеживается последний коммит в ветке по умолчанию:

{
  "dependencies": {
    "com.yangfch3.unity-mcp": "https://github.com/yangfch3/Unity-MCP-Server.git"
  }
}

При обновлении версии измените суффикс #tag в manifest.json на новый номер версии или повторно добавьте пакет через UPM GUI, введя URL с новым тегом.

Использование

Запуск службы

1. Unity Editor → Window → MCP Server

2. Установите порт (по умолчанию 8090) и нажмите Start

3. Скопируйте конфигурационный JSON из панели

Настройка агента

Добавьте следующее содержимое в файл конфигурации MCP вашего агента (например, mcp.json):

{
  "mcpServers": {
    "unity-mcp": {
      "url": "http://localhost:8090/"
    }
  }
}

Расширение: добавление пользовательских инструментов

Реализуйте интерфейс IMcpTool и поместите его в любую сборку Editor; служба автоматически обнаружит и зарегистрирует его при запуске:

using System.Collections.Generic;
using System.Threading.Tasks;
using UnityMcp.Editor;

public class MyCustomTool : IMcpTool
{
    public string Name => "my_custom_tool";
    public string Category => "custom";
    public string Description => "我的自定义工具";
    public string InputSchema => "{\"type\":\"object\",\"properties\":{}}";

    public Task<ToolResult> Execute(Dictionary<string, object> parameters)
    {
        return Task.FromResult(ToolResult.Success("Hello from custom tool!"));
    }
}

Требования

• Unity 2022.3+

• Только среда Editor, не влияет на сборку во время выполнения (runtime)

Участие в разработке

Приглашаем к участию в разработке проекта, подробности см. в CONTRIBUTING.md.

Лицензия

MIT