unity-manual-mcp
Unity Manual MCP
ローカルMCPサーバー (stdio) で、ローカルのUnityドキュメントインストールをAIアシスタントに提供します。
ドキュメントフォルダは通常、Unity Editorsのインストールディレクトリ内の Data\Documentation\en にあります。
Manual/— ハウツー記事。章ごとに構成されています(約3.5kページ)ScriptReference/— 完全なスクリプティングAPIリファレンス。クラス/プロパティ/メソッドごとに1ページ(約42kページ)
初回起動時に、サーバーはすべてのページのSQLite全文インデックスを構築し(Mozilla-Readabilityスタイルの記事本文抽出、ボイラープレート除去、コード例は保持)、それをOSの一時ディレクトリにキャッシュします。以降の起動ではそれを再利用します。ドキュメントのファイル数が変わると自動的に再構築されます。
要件
Python 3.10+ —
pyproject.tomlで宣言されています(fastmcp3.x で必要)。uv はこの条件を満たす既存のPythonを再利用し、互換性のあるインタープリタが存在しない場合にのみ新しいものをダウンロードします。
Related MCP server: unity-kb-mcp
セットアップ
リポジトリをクローンする
クローンしたリポジトリ内でターミナルを開く
実行する
uv sync
.venv を作成し、pyproject.toml から依存関係をインストールします。
実行
uv run server.py "C:\Program Files\Unity\Hub\Editor\<ver>\Editor\Data\Documentation\en"代わりに ...\Documentation または ...\Editor\Data を指定すると、en フォルダが自動検出されます。
フラグ:
--selftest— インデックスを構築してサンプルクエリを実行し、終了します(MCPサーバーなし。新しいセットアップの確認に適しています)--rebuild— インデックスの再構築を強制します--prune— マニフェストから古いキャッシュエントリ(dbファイルがないもの)を削除しますUNITY_DOCS_PATH環境変数 — 位置引数の代替です
ℹ 新規インストール後は、サーバーを手動で一度実行してドキュメントを事前にインデックス化し、初回使用時の待ち時間を避けてください
uv run server.py --selftest "C:\Program Files\Unity\Hub\Editor\<ver>\Editor\Data\Documentation\en"
MCPサーバーの追加
これはstdioサーバーであるため、ローカルプロセスを起動できる任意のクライアントで動作します。各クライアントは同じコマンドを実行します:
uv run --directory "<repo>" server.py "<docs path>"ここで <repo> はこのリポジトリのフォルダ、<docs path> はUnityドキュメントの en フォルダです(代わりに ...\Documentation または ...\Editor\Data を指定すると自動検出されます)。uv run は .venv 環境を自動的に作成・同期するため、クライアントはPATHにuvがあればよいだけです。
Claude Desktop
claude_desktop_config.json(ご自身のパスに置き換えてください):
{
"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 をプロジェクト内、またはグローバル設定(~/.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>"または ~/.codex/config.toml を編集します(ChatGPTデスクトップアプリおよびIDE拡張機能と共有されます。プロジェクトスコープの .codex/config.toml は信頼されたプロジェクトで機能します):
[mcp_servers.unity-manual]
command = "uv"
args = ["run", "--directory", "<repo>", "server.py", "<docs path>"]ツール
すべて読み取り専用(readOnlyHint):
ツール | 目的 |
| 全文検索(すべて / マニュアル / API) |
| ページを1件クリーンテキストとして読む(検索結果からのパス) |
| マニュアルの章、または章内のページを閲覧する |
| C#名でクラス/メンバーAPIページを探す |
インデックスキャッシュ
%TEMP%\unity-manual-mcp\ には、エディタごとに1つのdbファイル(例:<hash>.db)と、各ドキュメントパスをそのdbファイルにマッピングする manifest.json が保存されます。エディタを切り替えるとキャッシュされたインデックスが再利用され、HTMLファイル数によって検証されます。dbファイルを削除する(または --rebuild を使用する)と再構築が強制されます。--selftest は stale エントリ(dbファイルが存在しない)と orphaned エントリ(ドキュメントフォルダは消えたがdbは残っている)を報告します。--prune はstaleなものを削除します。
クレジット
すべてQwen 3.8 27bによって書かれました 🙂
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
Loading tool schema changelog…
This server cannot be deployed
Maintenance
Related MCP Connectors
MCP server for querying Forkast documentation
Agent-native MCP server over the public saagarpatel.dev corpus. Read-only, stateless.
An MCP server for search and retrieval over a local LanceDB database
Related MCP Servers
- AlicenseNot gradedqualityDmaintenanceGeneric MCP server that exposes Markdown documentation to LLMs, enabling them to search and answer questions about any software documentation.MIT
- AlicenseNot gradedqualityDmaintenanceAn MCP Server that provides Retrieval-Augmented Generation (RAG) capabilities to surface the latest Unity API documentation (currently v6.x).1MIT
- FlicenseNot gradedqualityDmaintenanceMCP server that exposes one or more documentation folders (Markdown, MDX, TXT) to AI agents, enabling listing, reading, and searching of documentation files.-
- AlicenseAqualityBmaintenanceA local MCP server that fetches official library documentation (llms.txt-first), caches it to disk, and serves relevant sections to coding agents offline with deterministic retrieval.37 npmMIT