unity-api-mcp
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
Как это работает
Определение версии. Сервер определяет, какую версию Unity обслуживать:
Приоритет | Источник | Пример |
1 | Переменная окружения |
|
2 |
| Читает |
3 | По умолчанию |
|
Загрузка базы данных. Если база данных для этой версии не кэширована локально, она загружается с GitHub. Минорные потоки Unity 6 (
6000.0,6000.3,6000.5, …) получают собственную базу данных для каждого потока, с откатом к общей базе6, если база для потока не опубликована. Кэшированные базы данных проверяются на свежесть относительно релиза при запуске, поэтому еженедельные пересборки автоматически достигают существующих установок.Обслуживание. Все вызовы инструментов запрашивают версионную SQLite-базу данных. Каждый запрос возвращается менее чем за 15 мс.
Для каждой версии существует своя база данных с правильными сигнатурами, предупреждениями об устаревании и списками членов для этого релиза.
Инструменты
Инструмент | Назначение | Пример |
| Поиск API по ключевым словам | "Tilemap SetTile", "async load scene" |
| Точные сигнатуры со всеми перегрузками |
|
| Определение директив | "SceneManager" -> |
| Полная справочная карточка класса | "InputAction" -> все методы/поля/свойства |
| Проверка, устарел ли API | "WWW" -> Используйте UnityWebRequest вместо этого |
Охват
Все модули 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/ и запускается одной командой.
Конфигурация | Правильно | Частично | Неправильно | Галлюцинированные API |
MCP + целевое чтение | 24/25 | 1 | 0 | 0 |
Опытный (Grep+Read) | 20/25 | 3 | 2 | 1 |
Наивный (только Read) | 19/25 | 3 | 3 | 1 |
Единственная воспроизведённая галлюцинация поучительна. Когда агентов попросили перечислить перегрузки 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 для обслуживания |
|
| Автоопределение версии из проекта |
|
| Переопределение пути установки Unity (только для |
|
Если вы хотите собрать базу данных из собственной установки 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/.
Лицензия
Available Tools
5 toolsget_class_referenceA
Get a complete reference card for a Unity class — all public methods, properties, fields, and events.
Use this when you want to see everything available on a class at a glance.
Args: class_name: Class name with or without namespace. Examples: "Rigidbody", "Tilemap", "InputAction", "SceneManager"
Inputs: class_name (required). Returns: result
get_deprecation_warningsA
Check whether a Unity class, method, or property is deprecated, and find the replacement.
Use this before using any API you suspect might be outdated. Catches common mistakes like using FindObjectOfType (deprecated) instead of FindAnyObjectByType.
Args: name: Class or member name to check. Examples: "WWW", "FindObjectOfType", "GUIText", "UnityEngine.Component.BroadcastMessage"
Inputs: name (required). Returns: result
get_method_signatureA
Look up the exact signature of a Unity API member by fully-qualified name.
Use this when you know the specific API (e.g. from autocomplete or docs reference) and need its exact parameters, return type, and deprecation status.
Args: fqn: Fully-qualified name, e.g. "UnityEngine.Physics.Raycast" or "UnityEngine.SceneManagement.SceneManager.LoadScene" Method overloads include params: "UnityEngine.Physics.Raycast(UnityEngine.Ray)"
Inputs: fqn (required). Returns: result
get_namespaceA
Find the correct namespace and using directive for a Unity class or member.
Use this when you need to know which namespace to import for a Unity type.
Args: name: Class or member name, e.g. "SceneManager", "NavMeshAgent", "Rigidbody"
Inputs: name (required). Returns: result
search_unity_apiA
Search Unity API documentation by keyword.
Use this to find Unity classes, methods, properties, and fields. Returns ranked results with summaries.
Args: query: Search terms (e.g. "Physics Raycast", "SceneManager load", "Transform position") n_results: Max results to return (default 5, max 20) member_type: Optional filter — "type", "method", "property", "field", or "event"
Inputs: query (required), n_results, member_type. Returns: result
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
Loading tool schema changelog…
TDQS
Scored across 5 tools
Each tool has a discernible niche: search_unity_api is keyword-based fuzzy lookup, get_class_reference returns a full class card, get_method_signature resolves a precise FQN, get_namespace maps a type to its using directive, and get_deprecation_warnings checks obsolescence. The main overlap is that get_method_signature already surfaces deprecation status and search can return members, but input-shape differences keep boundaries mostly clear.
All tools follow a predictable verb_noun pattern: get_class_reference, get_deprecation_warnings, get_method_signature, get_namespace, with search_unity_api as the single search verb. The convention is uniform and readable throughout.
Five tools is well-scoped for a documentation/API-lookup server. Each tool covers a distinct lookup mode (class card, signature, namespace, deprecation, keyword search) and none feels like filler.
The surface covers the core reference needs: finding classes/members, exact signatures, namespaces, and deprecation. Minor gaps exist such as inheritance hierarchy or example/usage lookup, but agents can work around these with the existing tools.
Maintenance
Related MCP Connectors
Make games with AI: one MCP server that connects your agent to Unity, Unreal and Godot editors.
MCP server for agentverse documentation, generated by doc2mcp.
Augments MCP Server - A comprehensive framework documentation provider for Claude Code
An MCP server that gives your AI access to the source code and docs of all public github repos
Related MCP Servers
- FlicenseNot gradedqualityDmaintenanceAn intelligent MCP server that enables AI agents to crawl, index, and semantically search official framework documentation using local RAG. It prevents hallucinations by providing precise, up-to-date documentation excerpts directly into the AI's context window.1-

Funplay MCP for Unityofficial
AlicenseNot gradedqualityAmaintenanceThis MCP server integrates AI assistants with Unity Editor, allowing them to create scenes, generate scripts, simulate input, and automate workflows using 91 built-in tools.304MIT- AlicenseNot gradedqualityDmaintenanceAn MCP server that provides tools to fetch live, version-accurate documentation, changelogs, examples, and method signatures for npm and PyPI packages, preventing AI coding agents from hallucinating stale APIs.MIT
- AlicenseNot gradedqualityDmaintenanceAn MCP Server that provides Retrieval-Augmented Generation (RAG) capabilities to surface the latest Unity API documentation (currently v6.x).1MIT