Unity API Documentation

unity-api-mcp

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

Unity 6（マイナーバージョン系列ごとにデータベースを用意）、Unity 2023、Unity 2022 LTS に対応しています。Claude Code、Cursor、Windsurf、および MCP 対応の AI ツールで利用できます。Unity のインストールは不要です。対応バージョンをご覧ください。新しい Unity リリースは毎週自動で検出され、ビルドされます。

クイックスタート

UNITY_VERSION をプロジェクトに合わせて設定し、MCP 設定（.mcp.json、mcp.json、またはツールの MCP 設定）に追加します。

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

有効な値："6000.3" のような Unity 6 の系列、または "6"、"2023"、"2022"。

初回起動時に、サーバーは適切なデータベース（約20～30 MB）を ~/.unity-api-mcp/ にダウンロードします。

動作の仕組み

1. バージョンの検出。 サーバーは、提供する Unity のバージョンを次のように判定します。

2. データベースのダウンロード。 該当するバージョンのデータベースがローカルにキャッシュされていない場合、GitHub からダウンロードします。Unity 6 のマイナー系列（6000.0、6000.3、6000.5、…）にはそれぞれ専用のデータベースがあり、系列のデータベースが公開されていない場合は汎用の 6 データベースにフォールバックします。起動時にキャッシュ済みデータベースの最新性をリリースと照合するため、毎週の再ビルドは既存のインストールにも自動的に反映されます。

3. 提供。 すべてのツール呼び出しは、バージョン固有の SQLite データベースを検索します。各クエリの応答は15ミリ秒未満です。

各バージョンには、そのリリースに対応した正確なシグネチャー、非推奨の警告、メンバー一覧を含む専用データベースがあります。

ツール

対象範囲

すべての 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 を使わない 2 つのエージェントは、存在しない単一引数の LoadSceneAsync(string) と LoadSceneAsync(int) のオーバーロードをでっち上げました。これらを使って書いたコードはコンパイルできません。MCP エージェントは、実在する 4 つのオーバーロードを正確に返しました。

なぜトークン削減ではなく正確さなのか？現在、エージェント型ツールはコード検索に優れています。Claude Code には当初から Grep ツールが搭載されており、現在のモデルはまず検索し、その後、範囲を絞った行を読み取るため、実行時のトークン使用量はすべての設定でほぼ同等でした。しかし、正確なオーバーロード、名前空間、非推奨情報はプロジェクトファイルには一切含まれていません。MCP を使わないエージェントは使用例から推測するしかなく、推測を誤ればビルドが壊れます。

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)

セットアップの詳細

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

pip install unity-api-mcp

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

# 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/
├── 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

トラブルシューティング

関連項目

unreal-api-mcp：Unreal Engine（C++）向けの同様のツールです。UE のバージョンごとに週次でデータベースが自動ビルドされます。

お問い合わせ

お使いのエンジンやフレームワーク向けのカスタム MCP サーバーが必要ですか？AI を活用したゲーム開発でトークンの無駄を減らし、ハルシネーションを防ぐ MCP ツールを開発しています。チームの技術スタック向けに同様のものが必要でしたら、ご連絡ください。

[email protected]

ライセンス

MIT