article
README
🚀 uMCP
uMCP 是 MCP 协议的服务器实现,专为在 Unity 中与人工智能协同工作而设计。它是一个简约高效的服务器,可用于将 AI 智能体连接到 Unity 应用程序。
🚀 快速开始
- 打开你的 Unity 项目。
- 启动你的 MCP 客户端(如 VSCode 代理模式、Cursor、CLINE 等)。
- 开始交互!此时你的 MCP 客户端应能与 Unity 应用程序进行通信。
✨ 主要特性
- 安全性:uMCP 不允许 AI 执行任意代码,所有操作只能通过预先授权的操作来完成。
- 可扩展性:uMCP 设计为易于扩展,允许你通过
McpServerToolType和McpServerTool属性添加自定义命令和操作。你可以在Assets/NatsunekoLaboratory/VMCP目录中找到相关示例。
🔧 技术细节
uMCP 可以使用可流式传输的 HTTP 协议直接与 MCP 客户端通信,无需任何其他依赖。与其他依赖 Python、Node.js 或其他语言运行时等额外依赖项的 MCP 服务器相比,这使得它的实现更加高效和轻量级。
你的 MCP 客户端 <-- 可流式传输的 HTTP --> uMCP 服务器
📦 安装指南
前提条件
- Unity 编辑器:版本 2022.3 LTS 或更高版本。
- MCP 客户端必须支持可流式传输的 HTTP(例如,VSCode 代理模式、Cursor、CLINE 等)。
1. 安装 Unity 包
- 打开你的 Unity 项目。
- 转到
窗口 > 包管理器。 - 点击
+选择从 Git URL 添加包...。 - 输入 URL:
https://github.com/mika-f/uMCP.git?path=/Assets/NatsunekoLaboratory/uMCP - 点击
添加。 - 运行 Unity 项目时,MCP 服务器将自动启动。
2. 配置你的 MCP 客户端
将支持可流式传输的 HTTP 的 MCP 客户端(VSCode 代理模式、Cursor、CLINE 等)连接到 MCP 服务器。
http://localhost:7225/sse
VSCode 代理模式的示例配置:
{
"servers": {
"uMCP": {
"url": "http://localhost:7225/sse"
}
}
}
💻 使用示例
基础用法
using System;
using System.ComponentModel;
using NatsunekoLaboratory.uMCP.Protocol.Attributes;
using NatsunekoLaboratory.uMCP.Protocol.Abstractions;
using NatsunekoLaboratory.uMCP.Protocol.Interfaces;
namespace NatsunekoLaboratory.Examples.MyCustomCommands
{
[McpServerToolType]
public class MyCustomCommand
{
[McpServerTool]
[Description("这是一个执行特定操作的自定义命令。")]
public static IToolResult Execute([Description("自定义命令的示例参数。")] string exampleParameter)
{
// 你的自定义命令逻辑
return new TextResult($"使用参数执行自定义命令: {exampleParameter}");
}
}
}
📄 许可证
本项目采用 MIT 许可证,版权归 @6jz 所有。
Scan to contact