unity-api-mcp

MCP-сервер, предоставляющий AI-агентам точную документацию по Unity API. Предотвращает галлюцинированные сигнатуры, неправильные пространства имён и использование устаревших API.

Поддерживает Unity 6 (отдельная база данных для каждого минорного потока), Unity 2023 и Unity 2022 LTS. Работает с Claude Code, Cursor, Windsurf или любым MCP-совместимым AI-инструментом. Установка Unity не требуется. См. поддерживаемые версии. Новые релизы Unity обнаруживаются и собираются автоматически каждую неделю.

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

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

{
  "mcpServers": {
    "unity-api": {
      "command": "uvx",
      "args": ["unity-api-mcp"],
      "env": {
        "UNITY_VERSION": "6000.3"
      }
    }
  }
}

Допустимые значения: поток Unity 6, например "6000.3", или "6", "2023", "2022".

При первом запуске сервер загружает соответствующую базу данных (~20-30 МБ) в ~/.unity-api-mcp/.

Related MCP server: Funplay MCP for Unity

Как это работает

1. Определение версии. Сервер определяет, какую версию Unity обслуживать:

2. Загрузка базы данных. Если база данных для этой версии не кэширована локально, она загружается с GitHub. Минорные потоки Unity 6 (6000.0, 6000.3, 6000.5, …) получают собственную базу данных для каждого потока, с откатом к общей базе 6, если база для потока не опубликована. Кэшированные базы данных проверяются на свежесть относительно релиза при запуске, поэтому еженедельные пересборки автоматически достигают существующих установок.

3. Обслуживание. Все вызовы инструментов запрашивают версионную SQLite-базу данных. Каждый запрос возвращается менее чем за 15 мс.

Для каждой версии существует своя база данных с правильными сигнатурами, предупреждениями об устаревании и списками членов для этого релиза.

Инструменты

Охват

Все модули UnityEngine и UnityEditor, а также пакеты, разобранные из C#-исходников: Input System, Addressables, uGUI (включая TextMeshPro на Unity 6), AI Navigation и Netcode. ~42 500 записей в каждой базе данных Unity 6, ~500 предупреждений об устаревании в каждой.

Полный список версий: страница релиза db-v1. CI перегенерирует эту таблицу при каждой сборке. Новые патчи Unity обнаруживаются и собираются автоматически каждый понедельник.

Не охватывает сторонние активы (DOTween, VContainer, Newtonsoft.Json). Для них полагайтесь на исходный код проекта.

Бенчмарки

Измерено, не обещано: 25 исследовательских вопросов в 3 тестовых средах, на которые ответили 3 конфигурации агентов, каждый ответ оценён относительно истины, предварительно проверенной в исходниках. Полная инфраструктура находится в docs/benchmark/ и запускается одной командой.

Единственная воспроизведённая галлюцинация поучительна. Когда агентов попросили перечислить перегрузки SceneManager.LoadSceneAsync, оба агента без MCP выдумали несуществующие одноаргументные перегрузки LoadSceneAsync(string) и LoadSceneAsync(int). Код, написанный под них, не компилируется. Агент с MCP вернул точные четыре реальные перегрузки.

Почему важна правильность, а не экономия токенов? Агентные инструменты сейчас хорошо ищут код. Claude Code с самого начала имеет инструмент Grep, и современные модели сначала ищут, а затем читают узкий диапазон строк, поэтому сырое использование токенов было сопоставимо во всех конфигурациях в наших прогонах. Но точные перегрузки, пространства имён и устаревшие API вообще отсутствуют в ваших файлах проекта. Агент без MCP может только вывести их из примеров использования, и когда он ошибается, вы платите сломанной сборкой.

• 3 тестовые среды: реальный игровой проект на Unity 6 (11 вопросов), чистые запросы Unity API (8) и исходный код пакета Unity Input System с файлами от 2 700 до 4 600 строк (6)

• 3 конфигурации, одна и та же модель и лимит ходов: инструменты MCP + Grep/Read, только Grep/Read, только Read

• Истина проверена чтением исходников до любых запусков; ответы оценены отдельной сессией модели относительно этой истины; использование токенов взято из полей использования API

• Запустите сами: python docs/benchmark/run.py --project <unity-project-path> (результаты от июля 2026; поведение агентов меняется, поэтому перезапустите перед цитированием)

Фрагмент CLAUDE.md

Добавьте это в файл CLAUDE.md вашего проекта (или эквивалентный файл инструкций). Этот шаг важен. Без него у AI есть инструменты, но он не будет знать, когда их использовать.

## Unity API Lookup (unity-api MCP)

Use the `unity-api` MCP tools to verify Unity API usage instead of guessing. **Do not hallucinate signatures.**

| When | Tool | Example |
|------|------|---------|
| Unsure about a method's parameters or return type | `get_method_signature` | `get_method_signature("UnityEngine.Tilemaps.Tilemap.SetTile")` |
| Need the `using` directive for a type | `get_namespace` | `get_namespace("SceneManager")` |
| Want to see all members on a class | `get_class_reference` | `get_class_reference("InputAction")` |
| Searching for an API by keyword | `search_unity_api` | `search_unity_api("async load scene")` |
| Checking if an API is deprecated | `get_deprecation_warnings` | `get_deprecation_warnings("FindObjectOfType")` |

**Rules:**
- Before writing a Unity API call you haven't used in this conversation, verify the signature with `get_method_signature`
- Before adding a `using` directive, verify with `get_namespace` if unsure
- Covers: all UnityEngine/UnityEditor modules, Input System, Addressables, uGUI/TextMeshPro, AI Navigation, Netcode
- Does NOT cover: DOTween, VContainer, Newtonsoft.Json (third-party)

Детали настройки

Вместо установки UNITY_VERSION вы можете указать путь к вашему проекту Unity. Сервер автоматически читает ProjectSettings/ProjectVersion.txt:

{
  "mcpServers": {
    "unity-api": {
      "command": "uvx",
      "args": ["unity-api-mcp"],
      "env": {
        "UNITY_PROJECT_PATH": "/path/to/your/unity-project"
      }
    }
  }
}

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

pip install unity-api-mcp

{
  "mcpServers": {
    "unity-api": {
      "command": "unity-api-mcp",
      "args": [],
      "env": {
        "UNITY_VERSION": "6000.3"
      }
    }
  }
}

Если вы хотите собрать базу данных из собственной установки Unity вместо загрузки:

# Install with ingest dependencies
pip install unity-api-mcp[ingest]

# Windows
python -m unity_api_mcp.ingest --unity-version 6000.3 --unity-install "D:/Unity/6000.3.8f1" --project "F:/Unity Projects/MyProject"

# macOS
python -m unity_api_mcp.ingest --unity-version 6000.3 --unity-install "/Applications/Unity/Hub/Editor/6000.3.20f1" --project "/path/to/UnityProject"

# Legacy versions
python -m unity_api_mcp.ingest --unity-version 2022 --unity-install "D:/Unity/2022.3.62f1"

Базы данных по умолчанию записываются в ~/.unity-api-mcp/unity_docs_{version}.db.

Если AI-агент настраивает это для вас:

Добавьте unity-api-mcp в мою конфигурацию MCP с помощью uvx, установив UNITY_VERSION в соответствии с моим проектом, добавьте фрагмент CLAUDE.md из README и проверьте с помощью get_namespace("SceneManager").

unity-api-mcp/
├── src/unity_api_mcp/
│   ├── server.py          # MCP server (5 tools)
│   ├── db.py              # SQLite + FTS5 database layer
│   ├── version.py         # Version detection + DB download
│   ├── xml_parser.py      # Parse Unity XML IntelliSense files
│   ├── cs_doc_parser.py   # Parse C# doc comments from package source
│   ├── unity_paths.py     # Locate Unity install + package dirs
│   └── ingest.py          # CLI ingestion pipeline
└── pyproject.toml

Базы данных хранятся в ~/.unity-api-mcp/.

Лицензия

MIT