MCP Unity

🚀 Unity MCP 協議整合指南

本指南將詳細介紹如何在 Unity 項目中整合 MCP 協議，涵蓋安裝、項目結構、運行、配置、調試、故障排查等方面的內容，幫助你快速上手使用。

🚀 快速開始

在開始整合 MCP 協議之前，請確保你已經完成以下步驟：

1. 通過 Git 克隆倉庫：

   git clone https://github.com/CoderGamester/mcp-unity.git
   cd mcp-unity
   

2. 在 Unity 中導入以下包至 Assets/Package Manager：
   • Model Context Protocol
   • WebSocketSharp

📦 安裝指南

獲取代碼

1. 使用 Git 克隆倉庫：

   git clone https://github.com/CoderGamester/mcp-unity.git
   cd mcp-unity
   

2. 在 Unity 中導入指定的包到 Assets/Package Manager：
   • Model Context Protocol
   • WebSocketSharp

📁 項目結構

mcp-unity/
├── Assets/             # Unity 工程資產
│   ├── Editor/         # MCP 編輯器腳本
│   └── PackageManager/ # 包管理配置文件
├── Server/            # Node.js 服務端代碼
│   ├── src/           # 源代碼文件夾
│   │   ├── index.ts    # 入口文件
│   │   └── server.ts   # 服務邏輯
│   └── build/         # 編譯生成目錄
├── .env                # 環境變量配置
└── README.md          # 使用文檔

🏃‍♂️ 運行說明

快速啟動

1. 在 Unity 中運行編輯器，並確保 MCP 組件已啟用。
2. 啟動 Node.js 服務：

   cd ABSOLUTE/PATH/TO/mcp-unity/Server
   npm install && node build/index.js
   

⚙️ 配置指南

環境變量設置

在根目錄創建或編輯 .env 文件，添加以下配置：

LOGGING=true
LOGGING_FILE=false
PORT=8090

服務端參數

通過命令行傳遞額外參數：

# 設置日誌級別
--logLevel debug

# 啟用遠程調試
--enableRemoteDebugging

🔧 運行時配置

MCP 協議版本

支持以下協議版本：

• v1.0.0
• v1.1.0（最新版）

網絡設置

1. 設置 WebSocket 服務器地址：

ws://localhost:8090

2. 配置 HTTP 接口端點：

"/api/v1"

🐞 調試指南

源碼調試

在 Server/src 目錄下，添加斷點並啟動調試程序。

日誌輸出

啟用控制檯日誌：

set LOGGING=true & set LOGGING_FILE=false

🛠️ 故障排查

連接問題

• 確認 WebSocket 服務器是否正在運行。
• 檢查防火牆設置，確保端口開放。
• 驗證連接地址和端口配置的正確性。

啟動失敗

• 查看 Unity 控制檯中的錯誤信息。
• 確保 Node.js 已正確安裝並加入 PATH。
• 核對依賴包版本要求。

💬 支持與反饋

問題報告

• 提交 Issue 到 GitHub
• 發送郵件至 support@mcprotocol.com

社區交流

參與以下社區討論：

• Unity 官方論壇
• MCP 協議技術群

📚 附錄

常見問題解答

1. 如何升級 MCP 版本？ 在 Package Manager 中選擇更新選項。
2. Node.js 服務無法啟動怎麼辦？

• 檢查 npm 包是否安裝成功。
• 確保 Node.js 版本符合要求（>=14.x）。

3. 如何禁用日誌輸出？ 在 .env 文件中設置 LOGGING=false。

術語表

• MCP：Model Context Protocol，模型上下文協議
• WebSocket：即時通信協議
• npm：Node 包管理工具

📄 許可證

本項目遵循 MIT 開源協議：

MIT License

Copyright (c) 2023 CoderGamester

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.