unity-api-mcp

AIエージェントに正確なUnity APIドキュメントを提供するMCPサーバー。幻覚のシグネチャ、間違った名前空間、非推奨APIの使用を防止します。

Unity 6（マイナーバージョンごとに1つのデータベース）、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 MB）を~/.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データベースにクエリを実行します。すべてのクエリは15ms未満で返ります。

各バージョンは、そのリリースに正しいシグネチャ、非推奨警告、メンバーリストを持つ独自のデータベースを持っています。

ツール

カバレッジ

すべてのUnityEngineおよびUnityEditorモジュールに加え、C#ソースから解析されたパッケージ：Input System、Addressables、uGUI（Unity 6ではTextMeshProを含む）、AI Navigation、Netcode。Unity 6データベースあたり約42,500レコード、それぞれ約500の非推奨警告。

完全なバージョンリスト：db-v1 リリースページ。CIはビルドのたびにそのテーブルを再生成します。新しいUnityパッチは毎週月曜日に自動検出され、データベースが構築されます。

対象外： サードパーティ製アセット（DOTween、VContainer、Newtonsoft.Json）。これらについては、プロジェクトのソースに依存してください。

ベンチマーク

測定値であり、保証ではありません：3つのテスト環境で25の調査質問を、3つのエージェント設定で回答し、各回答を事前にソースで検証した正解と照合して評価しました。完全なテストハーネスはdocs/benchmark/にあり、1つのコマンドで再実行できます。

再現された1つの幻覚は示唆に富んでいます。SceneManager.LoadSceneAsyncのオーバーロード一覧を求められたとき、MCP以外の両エージェントは存在しない単一パラメータのLoadSceneAsync(string)とLoadSceneAsync(int)のオーバーロードをでっち上げました。それらに基づいて書かれたコードはコンパイルできません。MCPエージェントは正確な4つの実際のオーバーロードを返しました。

なぜ正確性でトークン節約ではないのか？エージェンティックツールは現在コード検索が得意です。Claude Codeは最初からGrepツールを搭載しており、現在のモデルはまず検索してから狭い行範囲を読むため、生のトークン使用量はすべての設定でほぼ同等でした。しかし、正確なオーバーロード、名前空間、非推奨情報はプロジェクトファイルにはまったく含まれていません。MCPなしのエージェントは使用例から推測するしかなく、間違った推測をするとビルドが壊れるという代償を払うことになります。

• 3つのテスト環境：実際のUnity 6ゲームプロジェクト（11問）、純粋なUnity APIルックアップ（8問）、2,700～4,600行のファイルを含むUnity Input Systemパッケージソース（6問）

• 3つの設定、同じモデルとターン制限：MCPツール + Grep/Read、Grep/Readのみ、Readのみ

• 正解はすべての実行前にソースを読んで検証。回答は別のモデルセッションでその正解と照合して判定。トークン使用量はAPI使用量フィールドから取得

• 自分で実行：python docs/benchmark/run.py --project <unity-project-path>（2026年7月の結果。エージェントの動作は変化するため、引用前には再実行してください）

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_VERSIONをプロジェクトに合わせて設定し、uvxを使用してunity-api-mcpをMCP設定に追加し、READMEからCLAUDE.mdスニペットを追加し、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/に保存されます（初回実行時にダウンロード）。

トラブルシューティング

関連情報

unreal-api-mcp：Unreal Engine（C++）向けの同様のコンセプト。UEバージョンごとに毎週自動構築されるデータベース。

連絡先

エンジンやフレームワーク向けのカスタムMCPサーバーが必要ですか？AI支援ゲーム開発向けに、トークンの無駄を削減し幻覚を防止するMCPツールを構築しています。チームのスタックに同様のものが必要な場合は、ご連絡ください。

fuatcankoseoglu@gmail.com

ライセンス

MIT