Unity Manual MCP

Lokaler MCP-Server (stdio), der eine lokale Unity-Dokumentationsinstallation für Ihren KI-Assistenten bereitstellt.

Das Dokumentationsverzeichnis befindet sich normalerweise in Ihrem Unity-Editors-Installationsverzeichnis unter Data\Documentation\en.

• Manual/ — How-to-Artikel, in Kapiteln organisiert (~3.5k Seiten)

• ScriptReference/ — vollständige Scripting-API-Referenz, eine Seite pro Klasse / Eigenschaft / Methode (~42k Seiten)

Beim ersten Start erstellt der Server einen SQLite-Volltextindex aller Seiten (Extraktion des Artikeltexts im Stil von Mozilla-Readability, Boilerplate entfernt, Codebeispiele bleiben erhalten) und speichert ihn im temporären Verzeichnis des Betriebssystems. Bei späteren Starts wird er wiederverwendet; er wird automatisch neu aufgebaut, wenn sich die Anzahl der Dokumentationsdateien ändert.

Voraussetzungen

• uv

• Python 3.10+ — deklariert in pyproject.toml (erforderlich für fastmcp 3.x). uv verwendet jedes bereits installierte Python, das diese Anforderung erfüllt, und lädt nur dann ein neues herunter, wenn kein kompatibler Interpreter vorhanden ist.

Einrichtung

• Repository klonen

• Ein Terminal im geklonten Repository öffnen

• Ausführen:

  uv sync

Erstellt .venv und installiert die Abhängigkeiten aus pyproject.toml.

Ausführen

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

Der en-Ordner wird automatisch erkannt, wenn Sie stattdessen auf ...\Documentation oder ...\Editor\Data zeigen.

Optionen:

• --selftest — den Index erstellen und Beispielabfragen ausführen, dann beenden (kein MCP-Server; gut, um eine neue Einrichtung zu überprüfen)

• --rebuild — den Neuaufbau des Index erzwingen

• --prune — veraltete Cache-Einträge (DB-Datei fehlt) aus dem Manifest entfernen

• UNITY_DOCS_PATH Umgebungsvariable — Alternative zum Positionsargument

ℹ Führen Sie den Server nach einer Neuinstallation einmal manuell aus, um die Dokumentation vorzuindizieren und das Warten bei der ersten Verwendung zu vermeiden.

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

Hinzufügen des MCP-Servers

Dies ist ein stdio-Server, daher funktioniert jeder Client, der einen lokalen Prozess starten kann. Jeder Client führt denselben Befehl aus:

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

wobei <repo> der Ordner dieses Repositorys und <docs path> Ihr Unity-Dokumentations-en-Ordner ist (automatisch erkannt, wenn Sie stattdessen auf ...\Documentation oder ...\Editor\Data zeigen). uv run erstellt und synchronisiert die .venv-Umgebung automatisch, sodass der Client nur uv im PATH benötigt.

Claude Desktop

claude_desktop_config.json (ersetzen Sie die Pfade durch Ihre eigenen):

{
  "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 im Projekt oder die globale Konfiguration (~/.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>"

Oder bearbeiten Sie ~/.codex/config.toml (gemeinsam mit der ChatGPT-Desktop-App und der IDE-Erweiterung genutzt; ein projektspezifisches .codex/config.toml funktioniert in vertrauenswürdigen Projekten):

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

Werkzeuge

Alle schreibgeschützt (readOnlyHint):

Index-Cache

%TEMP%\unity-manual-mcp\ enthält pro Editor eine DB-Datei (z. B. <hash>.db) plus ein manifest.json, das jeden Dokumentationspfad seiner DB-Datei zuordnet. Beim Wechsel des Editors wird der gecachte Index wiederverwendet; er wird anhand der Anzahl der HTML-Dateien validiert. Löschen Sie eine DB-Datei (oder verwenden Sie --rebuild), um einen Neuaufbau zu erzwingen. --selftest meldet **veraltete** Einträge (DB-Datei fehlt) und **verwaiste** Einträge (Dokumentationsordner entfernt, DB noch vorhanden); --prune entfernt die veralteten.

Danksagungen

Vollständig geschrieben von Qwen 3.8 27b 🙂