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 文件。