使用说明（Markdown 格式）

• 项目简介

  • Unity MCP Vibe 将 MCP（Model Context Protocol）服务器能力直接嵌入到 Unity 编辑器中，提供资源管理、工具注册/执行、以及提示模板等能力，目标是为大型语言模型客户端提供高效、标准化的后端上下文服务。

• 主要功能点

  • 自动发现并注册 MCP 工具（Tools）与资源（Resources），通过统一的命令注册系统实现对外调用。
  • 支持在 Unity 编辑器中运行，结合各类 Editor/Runtime 工具，提供丰富的资源管理、场景/对象操作、以及 Prompts 渲染能力。
  • 提供多种传输方式的接入支持，包含标准输入/输出（Stdio）桥接、SSE（Server-Sent Events）等形式，方便与不同类型的 MCP 客户端对接。
  • 具备安全与合规机制（如对危险操作的审批、权限层级等），并在工具中实现了权限与日志记录的支持。
  • 运行阶段包含 CI/自动化、版本迁移以及 Editor 相关的工具链集成，便于持续集成环境使用。

• 安装步骤

  • 准备 Unity 环境：请使用 Unity 2021.3 及以上版本，Windows/Mac/Linux 均可运行开发环境。
  • 克隆或下载仓库并导入到 Unity 项目中：
    • 确保项目包含 Packages/UnityMCP-Vibe 及相关 Editor/Runtime 代码。
  • 启动方式（两种主要方式）
    • 通过 Unity 编辑器直接运行（Editor 模式），MCP 服务器会在 Unity 启动后以插件形式提供服务。
    • 通过标准输出/CI 集成（Stdio 桥接）：在命令行中以 Unity 可执行程序运行，并通过 MCP 的 Stdio 桥接启动服务器。具体入口由 McpCiBoot.StartStdioForCi 提供，CI 环境下可自动连接 Unity 的 Stdio 桥接。
  • 如需对接 HTTP/WS 客户端，请确保你的 Unity 实例对外暴露相应的传输端口与协议。

• 服务器配置（MCP 客户端需要的最小信息，以下为示例描述，非代码）

  • server name（服务器名称）
  • command（启动服务器的命令路径，例如 Unity 可执行程序路径）
  • args（启动参数，包含用于加载 MCP 服务的入口方法和传输设置的参数）
  • 备注：在本仓库中，启动 Stdio 运输的入口点是 StartStdioForCi，HTTP 传输则需要相应的服务器端实现和配置页面。实际使用时，请根据环境选择合适的启动方式。

  可能的配置示例（非代码块展示，请以文本形式理解）

  • server_name: "Unity-MCP-Vibe"
  • command: "Unity.exe"（Windows）/ "Unity"（macOS/Linux，取决于本地安装路径）
  • args: ["-batchmode", "-nographics", "-executeMethod", "MCPForUnity.Editor.McpCiBoot.StartStdioForCi"]
  • 说明: 使用 -executeMethod 指定 MSD 调用入口，启动后通过 Stdio 桥接与 MCP 客户端通信。若使用 HTTP/SSE，请确保服务端实现支持 /mcp 路径的 JSON-RPC 端点。

• 基本使用方法

  • 启动服务器：在 Unity 项目中打开并运行，或通过 CI/外部进程触发启动（如上述 StartStdioForCi 入口）。
  • 连接客户端：MCP 客户端通过配置的传输方式连接至服务器，若使用 SSE 将通过 http://localhost:8080/mcp 等端点进行交互（端口和端点可在服务器配置中设定）。
  • 使用与管理：客户端发送资源读取、工具调用、提示模板获取等请求，服务器按 MCP 协议解析 JSON-RPC 请求并返回结果。
  • 会话与安全：服务器端维护会话、能力声明以及对危险操作的审批流程，确保多人协作场景下的安全性。

• 注意事项

  • 本仓库以 Unity Editor 插件形式实现 MCP 服务端能力，运行环境以 Unity Editor 为主，CI/自动化场景提供了 Stdio 入口。
  • 若需将服务器暴露为对外 API，请确保网络安全配置、CORS、鉴权等在你的部署环境中得到妥善处理。