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.