このページは英語から機械翻訳されています。英語の原文を読む。

CLI リファレンス

unreal-mcp-cli の完全なコマンドリファレンス - Unreal MCP プラグインのインストール、サインイン、AI エージェントの設定、エディタの起動、ツールと Python の実行。

2026年11月4日に更新 Markdownで表示

unreal-mcp-cli は Unreal MCP 用のコマンドラインツールです。プラグインのインストールと更新、ai-game.dev へのサインイン、AI エージェント用 MCP 設定の書き出し、適切な接続設定での Unreal Editor の起動、スクリプトや CI からのツール呼び出しを行います。Windows、macOS、Linux で動作します。このページはバージョン 0.26.2 を対象としています。

CLI のインストール

Node.js ^20.19.0 または >=22.12.0 が必要です。

npm install -g unreal-mcp-cli
unreal-mcp-cli --version

または、インストールせずに 1 つのコマンドで実行できます:

npx unreal-mcp-cli@latest status

unreal-mcp-cli <command> --help を実行すると、各コマンドの組み込みヘルプが表示されます。グローバルフラグ -v, --verbose を指定すると、追加の診断情報が出力されます。

注意: プロジェクトを [path] として受け取るコマンドでは、位置引数として指定します。[path] を取らないコマンドでは -p, --path <dir> で指定します。どちらもデフォルトはカレントフォルダです。--path を取るコマンドに位置引数のパスを渡すと、「too many arguments」エラーになります。

コマンド一覧

コマンド用途
create-project <path>最小限の Unreal Engine C++ プロジェクトを生成
install-plugin [path]<project>/Plugins に UnrealMCP プラグインをインストール
update [path]インストール済みプラグインを更新
remove-plugin [path]プラグインを削除
install-extension <id> [path]Unreal MCP 拡張機能をインストール
loginai-game.dev にサインイン(デバイスコードフロー)
configureUNREAL_MCP_* の値を <project>/.env に書き込む
setup-mcp [agent]AI エージェント用の MCP 設定を書き込む
setup-skillsプロジェクト用の Claude Code スキルを書き込む
open [path]接続設定を指定して Unreal Editor を起動
close [path]プロジェクトを実行しているエディタを閉じる
exec [code]エディタ内で Python を実行
statusパッケージ、プロジェクト、プラグイン、接続の状態を表示
wait-for-readyプロジェクトの MCP サーバーが応答するまで待機
run-tool <tool>HTTP 経由で MCP ツールを呼び出す
run-system-tool <tool>HTTP 経由でシステムツールを呼び出す
bootstrap-local [path]ソースからブリッジをビルド
install-engine [version]インストール済みエンジンを検出し、Epic ランチャーへのリンクを表示

プロジェクト設定コマンド

create-project

最小限の C++ プロジェクトを生成します。オプション: --name <name>(プロジェクト名とモジュール名。英数字とアンダースコアのみ、ハイフン不可)、--engine <version>(EngineAssociation。例: 5.7)、--force(空でないフォルダを許可)。

unreal-mcp-cli create-project ./MyGame --engine 5.7

install-plugin

プラグインをインストールします。ローカルソースを指定しない場合は、CLI のバージョンと一致するプラグインソースを GitHub リリースからダウンロードし、事前に署名を検証します。

フラグ意味
--version <v>ダウンロードするプラグインリリース(デフォルト: CLI のバージョン)
--plugin-source <dir>ローカルのプラグインフォルダを使用(オフライン、CI、開発向け)
--junctionコピーではなくリンクを作成(Windows、プラグイン開発向け)
--with-serverチェックサム検証済みの gamedev-mcp-server もダウンロード
--server-version <v>, --server-source <path-or-url>--with-server 用のサーバーバージョン、またはローカル/カスタムソース
--enroll <code>, --enroll-stdinブラウザサインインの代わりにエージェント登録コードを使用
--base-url <url>--enroll 用の認証ベース URL
-y, --yesマシンを別のアカウントに切り替える確認

update

インストール済みプラグインを再同期します。バージョンが変わると、同梱のブリッジは保持したまま、古い Intermediate/ と C++ の Binaries/ を削除して Unreal がクリーンにリビルドできるようにします。フラグ: --version <v>、--plugin-source <dir>、--force(同じバージョンを再インストール)、--no-clean(ビルドキャッシュを保持)。

remove-plugin

プロジェクトから Plugins/UnrealMCP を削除します。オプションはありません。

install-extension

拡張機能をインストールし、.uproject でそれと依存するエンジンプラグインを有効化します。フラグ: --version <x.y.z>、--source <dir>、--build(今すぐコンパイル)、--engine-root <dir>(--build に使用するエンジン)、--force。

unreal-mcp-cli install-extension com.ivanmurzak.unreal-ai-pcg ./MyGame --build

bootstrap-local

ソースチェックアウト向けに、ブリッジをソースから <project>/Intermediate/UnrealMCP/ にビルドします。.NET 9 SDK が必要です。フラグ: --repo-root <dir>、--plan(ビルド計画の表示のみ)。

install-engine

インストール済みのエンジンを一覧表示するか、特定バージョンの有無を確認します。エンジンをダウンロードすることはありません。バージョンが見つからない場合は Epic Games Launcher へのリンクを表示します。フラグ: --manifest <path>(LauncherInstalled.dat を明示)、--install、--yes。

サインインと AI エージェントのコマンド

login

OAuth デバイスコードフローでサインインし、認証情報を ~/.ai-game-dev/credentials.json に保存します。このファイルはマシン上のすべての AI Game Dev ツールで共有されます。

フラグ意味
-p, --path <dir>認証情報をマシンのストアではなく、そのプロジェクトの .env に保存
--tools-onlyCI ランナー用のツール専用認証情報を作成(アプリでは使用不可)
-y, --yesマシンを別のアカウントに切り替えることを確認する
--base-url <url>認証ベース URL(デフォルト https://ai-game.dev)
--timeout <ms>ポーリング全体のタイムアウト

configure

UNREAL_MCP_* の値を <project>/.env に書き込み、.env を gitignore に追加します。フラグ:-p, --path、--mode <Cloud|Custom>、--host <url>、--cloud-url <url>、--token <token>、--auth <option>、--keep-connected、--tools <list>、--start-server、--transport <stdio|http>、--log-level <level>、--no-gitignore。

--agent <id> を指定した場合は代わりに、管理された gamedev-mcp-server にピン留めされたクライアント設定を書き込ませます。関連するフラグは --url、--server-version、--server-source です。

setup-mcp

1 つのエージェント用の MCP 設定エントリを書き込みます。エージェントの一覧は AI クライアントの接続 を参照してください。

フラグ意味
-p, --path <dir>プロジェクトフォルダー
--transport <t>http(デフォルト)または stdio(ローカルサーバーをダウンロード)
--url <url>明示的なサーバー URL
--token <token>明示的なベアラートークン。プロジェクトキーより優先される
--oauthCloud:URL のみの設定で、エージェント自身がサインインする
--regenerate-keyCloud:新しいプロジェクトキーを作成し、古いキーを無効化する
--no-pinプロジェクトにピン留めされた /mcp/p/<pin> の代わりに、通常の /mcp URL を使用する
--dry-runスニペットを書き込まずに出力する
--listサポートされているエージェントと設定パスを一覧表示する

setup-skills

.claude/skills/unreal-mcp/SKILL.md を書き込みます。フラグ:-p, --path、--url、--token、--force(上書き)。

エディターのコマンド

open

Unreal Editor を起動し、接続設定を UNREAL_MCP_* 環境変数として渡します。エンジンはプロジェクトの EngineAssociation から決まります。ソースからビルドしたエンジンには --engine-root が必要です。

フラグ意味
--connection-mode <mode>Custom または Cloud。--host のみを指定すると Custom とみなされる
--host、--token、--auth、--tools、--transport対応する UNREAL_MCP_* 変数を設定する
--keep-connected、--start-server対応する変数を true に設定する
--no-connectUNREAL_MCP_* 変数を一切渡さない
--headlessCLI が所有するウィンドウなしのエディターを起動し、準備が整うまで待機する
--idle <seconds>、--url <url>CLI 所有のエディターのアイドルシャットダウンとサーバー URL
--engine-root <dir>ソースビルド用のエンジンフォルダー
--no-build起動前のネイティブモジュールのビルドをスキップする
--no-auto-dismiss-startup-dialogsUnreal の起動時プロンプトに手を加えない
--startup-dismiss-timeout-ms、--startup-dismiss-poll-interval-msプロンプトの自動消去を調整する(デフォルト 12000 と 1000)
--no-cacheエンジンパスを再検出する

Linux では、起動時プロンプトの自動消去は X11 でのみ動作します。

close

プロジェクトを実行しているエディターを閉じます。--owned-only を指定すると、CLI が起動したエディター(exec または open --headless 経由)のみを閉じ、保存して終了します。自分で開いたエディターには一切触れません。--force は時間内に終了しない CLI 所有のエディターを強制終了します。--token はベアラートークンを上書きします。

exec

python-execute を通じてエディター内で Python を実行します。実行中のエディターを再利用するか、オフスクリーンでレンダリングするヘッドレスエディターを起動し(スクリーンショットも引き続き機能します)、ツール呼び出しがない状態が一定時間続くと終了します。

unreal-mcp-cli exec "unreal.SystemLibrary.get_engine_version()" -p ./MyGame

フラグ:-p, --path、-f, --file <file>(stdin には -)、--include <path>(.ai-game-dev/snippets のヘルパー、繰り返し指定可能)、--window、--idle <seconds>(デフォルト 300、0 = 終了しない)、--ready-timeout <ms>、--timeout <ms>、--raw(JSON レスポンスを出力)、--url、--token、--engine-root、--no-build。結果は stdout に、print() とログ行は stderr に出力されます。

ツールとステータスのコマンド

status と wait-for-ready

status は CLI、プロジェクト、プラグイン、接続を報告し、実際の到達性を確認します(--no-probe でスキップ)。wait-for-ready はサーバーが ping に応答するまでブロックします(--timeout、デフォルト 120000 ms、--interval、デフォルト 2000 ms)。どちらも -p, --path、--url、--token を受け付けます。

run-tool と run-system-tool

プロジェクトのローカル MCP サーバー経由で 1 つのツールを呼び出します:

unreal-mcp-cli run-tool rql-query -p ./MyGame --input '{"query":"actors | select Label"}'
unreal-mcp-cli run-system-tool ping -p ./MyGame

フラグ:-p, --path、--url、--token、--input <json>、--input-file <file>(stdin には -)、--timeout <ms>(デフォルト 60000)。

同じロジックは型付きライブラリ(import { openProject, runTool } from 'unreal-mcp-cli')としても利用でき、AI Game Dev アプリで使われています。