返回 MCP 目录
public公开dns本地运行

umcp

uMCP是一个专为Unity设计的MCP协议服务器实现,用于连接AI代理与Unity应用,具有安全性和可扩展性。

article

README

🚀 uMCP

uMCP 是 MCP 协议的服务器实现,专为在 Unity 中与人工智能协同工作而设计。它是一个简约高效的服务器,可用于将 AI 智能体连接到 Unity 应用程序。

🚀 快速开始

  1. 打开你的 Unity 项目。
  2. 启动你的 MCP 客户端(如 VSCode 代理模式、Cursor、CLINE 等)。
  3. 开始交互!此时你的 MCP 客户端应能与 Unity 应用程序进行通信。

✨ 主要特性

  • 安全性:uMCP 不允许 AI 执行任意代码,所有操作只能通过预先授权的操作来完成。
  • 可扩展性:uMCP 设计为易于扩展,允许你通过 McpServerToolTypeMcpServerTool 属性添加自定义命令和操作。你可以在 Assets/NatsunekoLaboratory/VMCP 目录中找到相关示例。

🔧 技术细节

uMCP 可以使用可流式传输的 HTTP 协议直接与 MCP 客户端通信,无需任何其他依赖。与其他依赖 Python、Node.js 或其他语言运行时等额外依赖项的 MCP 服务器相比,这使得它的实现更加高效和轻量级。

你的 MCP 客户端 <-- 可流式传输的 HTTP --> uMCP 服务器

📦 安装指南

前提条件

  • Unity 编辑器:版本 2022.3 LTS 或更高版本。
  • MCP 客户端必须支持可流式传输的 HTTP(例如,VSCode 代理模式、Cursor、CLINE 等)。

1. 安装 Unity 包

  1. 打开你的 Unity 项目。
  2. 转到 窗口 > 包管理器
  3. 点击 + 选择 从 Git URL 添加包...
  4. 输入 URL:
    https://github.com/mika-f/uMCP.git?path=/Assets/NatsunekoLaboratory/uMCP
    
  5. 点击 添加
  6. 运行 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 所有。

help

运行方式说明

cloud

托管运行

托管运行通常表示这个 MCP Server 由服务方环境承载,用户一般按页面提供的连接方式或授权流程接入,不需要在本地长期启动一个 MCP 进程

  1. 打开服务方连接页
  2. 完成授权或复制端点
  3. 在 MCP 客户端中连接
terminal

本地运行 / 其它方式

本地运行通常需要用户在自己的电脑或服务器上安装依赖,把 server_config 复制到 MCP 客户端,并按 env_schema 补齐环境变量、密钥或其它配置

  1. 复制 server_config
  2. 安装所需依赖
  3. 补齐环境变量后重启客户端