Unity Manual MCP

Локальный MCP-сервер (stdio), который предоставляет локально установленную документацию Unity вашему ИИ-ассистенту.

Папка документации обычно находится в каталоге установки Unity Editors, в подпапке Data\Documentation\en.

• Manual/ — статьи с инструкциями, организованные по главам (~3.5k страниц)

• ScriptReference/ — полный справочник по скриптовому API, по одной странице на класс / свойство / метод (~42k страниц)

При первом запуске сервер создаёт полнотекстовый индекс SQLite для каждой страницы (извлечение тела статьи в стиле Mozilla-Readability, удаление шаблонной информации, сохранение примеров кода) и кэширует его во временный каталог ОС. Последующие запуски используют его повторно; он автоматически пересоздаётся, если количество файлов документации меняется.

Требования

• uv

• Python 3.10+ — указано в pyproject.toml (требуется fastmcp 3.x). uv использует любой уже установленный Python, удовлетворяющий этому условию, и загружает новый только в том случае, если совместимого интерпретатора нет.

Настройка

• Склонируйте репозиторий

• Откройте терминал в клонированном репозитории

• Выполните

uv sync

Создаёт .venv и устанавливает зависимости из pyproject.toml.

Запуск

uv run server.py "C:\Program Files\Unity\Hub\Editor\<ver>\Editor\Data\Documentation\en"

Папка en определяется автоматически, если указать ...\Documentation или ...\Editor\Data.

Флаги:

• --selftest — создать индекс и выполнить пробные запросы, затем выйти (без MCP-сервера; удобно для проверки новой установки)

• --rebuild — принудительно пересоздать индекс

• --prune — удалить устаревшие записи кэша (отсутствует файл db) из манифеста

• UNITY_DOCS_PATH переменная окружения — альтернатива позиционному аргументу

ℹ После свежей установки запустите сервер вручную один раз, чтобы предварительно проиндексировать документацию и избежать ожидания при первом использовании

uv run server.py --selftest "C:\Program Files\Unity\Hub\Editor\<ver>\Editor\Data\Documentation\en"

Добавление MCP-сервера

Это stdio-сервер, поэтому подойдёт любой клиент, который может запускать локальный процесс. Каждый клиент выполняет одну и ту же команду:

uv run --directory "<repo>" server.py "<docs path>"

где <repo> — папка этого репозитория, а <docs path> — папка en документации Unity (автоматически определяется, если указать ...\Documentation или ...\Editor\Data). uv run автоматически создаёт и синхронизирует окружение .venv, поэтому клиенту нужен только uv в PATH.

Claude Desktop

claude_desktop_config.json (укажите свои собственные пути):

{
  "mcpServers": {
    "unity-manual": {
      "command": "uv",
      "args": ["run", "--directory", "<repo>", "server.py", "<docs path>"]
    }
  }
}

Claude Code

claude mcp add unity-manual -- uv run --directory "<repo>" server.py "<docs path>"

OpenCode

opencode.json в проекте или глобальный конфиг (~/.config/opencode/opencode.json):

{
  "mcp": {
    "unity-manual": {
      "type": "local",
      "command": ["uv", "run", "--directory", "<repo>", "server.py", "<docs path>"],
      "enabled": true
    }
  }
}

Codex

codex mcp add unity-manual -- uv run --directory "<repo>" server.py "<docs path>"

Или отредактируйте ~/.codex/config.toml (общий с настольным приложением ChatGPT и расширением IDE; проектный .codex/config.toml работает в доверенных проектах):

[mcp_servers.unity-manual]
command = "uv"
args = ["run", "--directory", "<repo>", "server.py", "<docs path>"]

Инструменты

Все доступны только для чтения (readOnlyHint):

Кэш индекса

%TEMP%\unity-manual-mcp\ содержит по одному файлу db для каждого редактора (например, <hash>.db) плюс manifest.json, сопоставляющий каждый путь к документации с его файлом db. При переключении редакторов переиспользуется кэшированный индекс; он проверяется по количеству HTML-файлов. Удалите файл db (или используйте --rebuild), чтобы принудительно пересоздать его. --selftest сообщает об **устаревших** записях (отсутствует файл db) и **осиротевших** записях (папка документации удалена, а db остался); --prune удаляет устаревшие.

Благодарности

Полностью написано Qwen 3.8 27b 🙂