Unreal Engine API Documentation

unreal-api-mcp

AI エージェントに正確な Unreal Engine C++ API ドキュメントを提供する MCP サーバーです。トークン、コンテキスト、時間を節約し、誤ったシグネチャ、間違った #include パス、非推奨 API の使用を防ぎます。

Claude Code、Cursor、Windsurf、または MCP 対応のあらゆる AI ツールで動作します。Unreal Engine のインストールは必要ありません。対応バージョンを確認してください。新しいバージョンは毎週自動的に検出され、ビルドされます。

クイックスタート

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

{
  "mcpServers": {
    "unreal-api": {
      "command": "uvx",
      "args": ["unreal-api-mcp"],
      "env": {
        "UNREAL_VERSION": "5.5"
      }
    }
  }
}

プロジェクトの UE バージョンに合わせて設定してください。利用可能なデータベースの一覧は、対応バージョンを参照してください。

初回起動時に、サーバーは適切なデータベースを ~/.unreal-api-mcp/ にダウンロードします。パッチバージョン（例："5.7.3"）に対応するデータベースがない場合は、メジャー.マイナーバージョンのデータベース（例："5.7"）を使用します。

仕組み

1. バージョン検出。 サーバーは、提供する UE バージョンを判定します：

プロジェクトに合わせて、いずれかを設定してください。どちらも設定されていない場合、サーバーは UE 5.7 をデフォルトで使用します。

2. データベースのダウンロード。 対応するバージョンのデータベースがローカルにキャッシュされていない場合、GitHub から（一度だけ）ダウンロードします。パッチバージョンの場合、必要に応じてメジャー.マイナーバージョンのデータベースを使用します。また、起動時に更新も確認します。

3. 提供。 すべてのツール呼び出しは、バージョンに対応した SQLite データベースを検索します。正確な検索は 1 ミリ秒未満、検索クエリは 5 ミリ秒未満で完了します。

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

ツール

対応範囲

Engine Runtime、Editor、Developer の全モジュールに加え、組み込みプラグイン（Enhanced Input、Gameplay Abilities、Common UI、Niagara、Chaos など数百件）に対応しています。

Blueprint グラフの内部も含まれます。158 個の UK2Node サブクラス、UEdGraphSchema_K2、BlueprintGraph、KismetCompiler、GraphEditor モジュール（1,120 件以上）が対象です。カスタム K2 ノードやエディターツールを作成する場合も、インデックス化されています。

対応バージョンとデータベースの全一覧は、db-v1 リリースページをご覧ください。新しいバージョンは毎週月曜日に検出され、CI によって自動的にビルドされます。

レコードの内訳（UE 5.7）：

サードパーティ製プラグインやマーケットプレイスのアセットは対象外です。それらについては、プロジェクトのソースを参照してください。

ベンチマーク

約束ではなく、実測値です。2つのテストベッドで14の調査質問に3つのエージェント設定が回答し、すべての回答を事前に検証した正解データ（API の事実はドキュメントデータベース、ソースコードの事実は UE 5.8 エンジンツリーと照合）に基づいて評価しました。完全なハーネスは docs/benchmark/ にあり、1つのコマンドで再実行できます。

差が現れるのは、予想とは異なる部分です。ドキュメントが充実した include やシグネチャ、そして1万4000行のエンジンファイル内で grep できる実装上の事実については、3つの設定すべてが同点です。最新のモデルは UE のドキュメント化された API を把握しており、ローカルのソースコードも適切に検索できます。差が開くのは、最近の非推奨化についてです。UKismetSystemLibrary::IsSplitScreen が 5.8 でもまだ有効かと尋ねたところ、MCP を使わないエージェントはどちらも誤答しました。一方は回答を控え、もう一方は問題ないと断言しました。実際には HasMultipleLocalPlayers に置き換えられ、非推奨になっています。また、どちらも AActor::NetUpdateFrequency への直接アクセスが非推奨になった 5.5 時代の変更について、誤った説明をしました。MCP エージェントは、非推奨フラグと置き換え先のヒントがデータベースにあるため、非推奨に関する3つの質問すべてに正しく答えました。

なぜ生の出力ではなく正確性を重視するのでしょうか。エージェント型ツールは、今ではコードをうまく検索できます。Claude Code には最初から Grep ツールが搭載されているため、エージェントはファイル内に実在するものなら何でも見つけられます。問題は、ファイル内にない情報、つまり正確なシグネチャ、#include のパス、特に新しい非推奨化です。これらはモデルの記憶にも確実に含まれているとは限らず、間違えるとビルドが失敗したり、非推奨の呼び出しが気づかれないまま使われたりします。

CLAUDE.md のスニペット

プロジェクトの CLAUDE.md（または同等の指示ファイル）に、これを追加してください。この手順は重要です。 追加しないと、AI はツールを使える状態でも、いつ使えばよいか分かりません。

## Unreal Engine API Lookup (unreal-api MCP)

Use the `unreal-api` MCP tools to verify UE C++ API usage instead of guessing. **Do not hallucinate signatures or #include paths.**

| When | Tool | Example |
|------|------|---------|
| Unsure about a function's parameters or return type | `get_function_signature` | `get_function_signature("AActor::GetActorLocation")` |
| Need the `#include` for a type | `get_include_path` | `get_include_path("ACharacter")` |
| Want to see all members on a class | `get_class_reference` | `get_class_reference("UCharacterMovementComponent")` |
| Searching for an API by keyword | `search_unreal_api` | `search_unreal_api("spawn actor")` |
| Checking if an API is deprecated | `get_deprecation_warnings` | `get_deprecation_warnings("K2_AttachRootComponentTo")` |
| Writing custom K2 nodes or editor tools | `get_class_reference` | `get_class_reference("UK2Node_SpawnActorFromClass")`, `get_class_reference("UEdGraphSchema_K2")` |

**Rules:**
- Before writing a UE API call you haven't used in this conversation, verify the signature with `get_function_signature`
- Before adding a `#include`, verify with `get_include_path` if unsure
- Covers: all Engine Runtime/Editor modules, built-in plugins (Enhanced Input, GAS, CommonUI, Niagara, etc.), Blueprint graph internals (UK2Node subclasses, EdGraphSchema, BlueprintGraph, KismetCompiler)
- Does NOT cover: third-party plugins or marketplace assets

セットアップの詳細

{
  "mcpServers": {
    "unreal-api": {
      "command": "uvx",
      "args": ["unreal-api-mcp"],
      "env": {
        "UNREAL_PROJECT_PATH": "F:/Unreal Projects/MyProject"
      }
    }
  }
}

pip install unreal-api-mcp

{
  "mcpServers": {
    "unreal-api": {
      "command": "unreal-api-mcp",
      "args": [],
      "env": {
        "UNREAL_VERSION": "5.5"
      }
    }
  }
}

# Build for a specific version
python -m unreal_api_mcp.ingest --unreal-version 5.6 --unreal-install "H:/UE_5.6"
python -m unreal_api_mcp.ingest --unreal-version 5.5 --unreal-install "H:/UE_5.5"

unreal-api-mcp/
├── src/unreal_api_mcp/
│   ├── server.py          # MCP server (5 tools)
│   ├── db.py              # SQLite + FTS5 database layer
│   ├── version.py         # Version detection + DB download
│   ├── header_parser.py   # Parse Unreal C++ headers (UCLASS, UFUNCTION, etc.)
│   ├── unreal_paths.py    # Locate UE installs + discover modules
│   └── ingest.py          # CLI ingestion pipeline
└── pyproject.toml

トラブルシューティング

関連項目

unity-api-mcp：Unity（C#）向けの同様のツールです。Unity 2022、2023、Unity 6 に対応しています。

お問い合わせ

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

[email protected]

ライセンス

MIT

個人的または非営利の目的であれば、自由に使用、フォーク、改変、共有できます。 商用利用には許可が必要です。