Vrchat MCP Osc

🚀 VRChat MCP OSC

VRChat MCP OSC 通過 Model Context Protocol (MCP) 搭建了 AI 助手與 VRChat 之間的橋樑，實現基於人工智能的虛擬化身控制和交互，為虛擬現實環境提供支持。它能讓 AI 助手在 VRChat 中精準控制虛擬角色，實現多樣化交互，極大豐富了虛擬現實體驗。

🚀 快速開始

VRChat MCP OSC 藉助 Open Sound Control (OSC) 與 VRChat 進行通信，允許如 Claude 等 AI 助手控制角色參數與表情、發送消息以及執行其他交互操作。

✨ 主要特性

• AI 驅動的虛擬化身控制：通過 MCP 協議實現 AI 對虛擬角色的精細控制。
• 多平臺兼容性：支持不同設備和 VR 系統，確保廣泛兼容。
• 高效的通信機制：利用 OSC 實現低延遲、高效率的數據傳輸。

📦 安裝指南

系統要求

• Node.js 18 或更高版本
• 具備 OSC 支持的 VRChat
• 配備 MCP 實現的 Claude Desktop

命令行配置

# 創建並導航至項目目錄
mkdir -p vrchat-mcp-osc
cd vrchat-mcp-osc

# 克隆倉庫
git clone https://github.com/Krekun/vrchat-mcp-osc.git .

# 安裝依賴項
pnpm install

# 構建項目
pnpm build

# 啟動服務
npm start

📚 詳細文檔

參數配置

基本參數

--port <number>         # 監聽端口，默認值為 3000
--host <string>         # 監聽地址，默認為 localhost
--debug                 # 啟用調試模式

高級選項

--max_connections <number>  # 最大連接數，默認為 100
--timeout <seconds>        # 閒置超時時間，單位秒，默認為 3600

功能模塊

核心組件

• MCP 服務器：負責處理來自 AI 的指令和數據。
• WebSocket 中繼：實現 WebSocket 到 OSC 的協議轉換。
• 類型定義：提供統一的 TypeScript 接口規範。

工具集

• 日誌記錄與監控：即時跟蹤系統運行狀態。
• 性能優化工具：提升通信效率和穩定性。

項目架構

vrchat-mcp-osc/
├── packages/
│   ├── mcp-server/    # MCP 協議實現的主入口
│   ├── relay-server/  # WebSocket 到 OSC 的協議轉換器
│   ├── types/         # 共享的 TypeScript 接口定義
│   └── utils/         # 常用工具函數
└── pnpm-workspace.yaml  # 工作區配置文件

開發指南

源碼構建

# 克隆倉庫
git clone https://github.com/Krekun/vrchat-mcp-osc.git

# 安裝依賴項
pnpm install

# 構建所有包
pnpm -r build

# 開發模式啟動
pnpm -r dev

📄 許可證

VRChat MCP OSC 採用雙授權許可：

• 非商業用途：遵循 MIT 許可證，詳情參見 MIT 許可證文件。
• 商業用途：需另行獲取商業許可證。

通過本軟件的 MIT 許可證用於非商業目的，您須遵守該許可條款。商業用戶必須獲得相應的商業授權。

致謝

感謝以下團隊與項目的貢獻：

• VRChat 團隊為 OSC 集成所做的工作
• Model Context Protocol 提供標準化 AI 接口
• Anthropic 對 Claude 的 MCP 實現