Unity MCP Server

中文 | English

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

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

Концепция

Этот плагин позиционируется как слой восприятия Unity + инструментарий диагностики для AI-агентов:

• Восприятие в приоритете — приоритет отдается часто используемым сценариям, таким как «чтение состояния сцены, получение контекста, вспомогательная диагностика», чтобы агент мог полностью понимать текущее состояние проекта и помогать в принятии решений при разработке.

• Структурированная запись — предоставляет безопасные и проверяемые возможности записи (например, изменение свойств, добавление/удаление узлов), но не стремится охватить все взаимодействия графического интерфейса Unity Editor.

• Не замена редактору — цель состоит в повышении эффективности сотрудничества между инженером и агентом, а не в переносе всех операций редактора в диалоговое окно.

Related MCP server: MCP Unity

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

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

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

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

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

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

Полное описание параметров и примеры использования см. в подробной документации по инструментам.

Инструменты отладки (Debug)

Инструменты редактора (Editor)

Query (Запросы)

Mutation (Изменения)

Project (Проект)

Asset (Активы)

Инструменты сборки (Build)

Инструменты кода (Code) (экспериментально, только Unity 2022 Mono)

Необходимо вручную включить на панели Window → MCP Server. Подробности см. в подробной документации по инструментам.

Установка

Установка через 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 текущий хеш коммита фиксируется в файле packages-lock.json проекта. В дальнейшем автоматическое обновление не происходит.

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

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

Соответствующая конфигурация Packages/manifest.json:

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

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

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

При обновлении версии измените суффикс #tag в manifest.json на новый номер версии или снова выберите Add package from git URL в 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