Unity MCP

🚀 Unity MCP 服务器

本项目是一个用于将 Claude 连接到 Unity 项目的 MCP 服务器，借助 Model Context Protocol SDK 构建而成，能有效实现 Claude 与 Unity 项目的连接。

✨ 主要特性

• 可列出所有 Unity 项目。
• 能获取项目详细信息。
• 支持访问项目结构和文件。

📦 安装指南

选项 1：使用 NPX（推荐）

可直接使用 npx 运行此工具，无需安装，命令如下：

npx unity-mcp@latest

在 Claude 中将此工具配置为 MCP 服务器：

• 在 MacOS 上：配置文件路径为 ~/Library/Application\ Support/Claude/claude_desktop_config.json。
• 在 Windows 上：配置文件路径为 %APPDATA%/Claude/claude_desktop_config.json%。

配置内容如下：

{
  "mcpServers": {
    "unity": {
      "command": "npx",
      "args": ["unity-mcp@latest"]
    }
  }
}

选项 2：本地运行此项目

克隆此仓库以本地运行：

git clone https://github.com/your-username/unity-mcp.git
cd unity-mcp
bun install

然后配置 Claude 使用你的本地版本：

{
  "mcpServers": {
    "unity": {
      "command": "bun",
      "args": ["run", "C:\\Users\\Artga\\Code\\unity-mcp\\src\\index.ts"]
    }
  }
}

要求

• 安装了 Unity 并配置了一些项目。
• 具备 Bun 运行时环境。

故障排除

如果无法使用此 MCP 工作，请打开问题。以下是一些提示：

1. 确保已安装 Unity 并且配置了一些项目。
2. 检查 unity-mcp 服务器是否可以访问 projects-v1.json 文件。
3. 确保对 Unity 项目目录有适当的权限。

此 MCP 将日志输出到标准错误，符合 MCP 规范。在 MacOS 上，Claude Desktop 应用会将这些日志输出到 ~/Library/Logs/Claude。在其他平台上，你可以在此处找到日志。

💻 使用示例

基础用法

使用 NPX 运行此工具：

npx unity-mcp@latest

高级用法

本地克隆并运行项目：

git clone https://github.com/your-username/unity-mcp.git
cd unity-mcp
bun install

📚 详细文档

开发

设置

# 安装依赖项
bun install

# 运行项目
bun run src/index.ts

# 类型检查
bun run typecheck

# 格式化代码
bun run format

调试

由于 MCP 服务器通过标准输入输出运行，调试可能具有挑战性。为了获得最佳的调试体验，我们强烈推荐使用 MCP Inspector。 可以使用以下命令启动 MCP 检查器：

bun run inspector

启动后，检查器会显示一个 URL，可以在浏览器中访问以开始调试。

📄 许可证

本项目采用 MIT License，有关详细信息，请参阅 LICENSE 文件。