rbxstudio-mcp 1.9.0

package/dist/tools/studio-client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"studio-client.js","sourceRoot":"","sources":["../../src/tools/studio-client.ts"],"names":[],"mappings":"AAEA,MAAM,OAAO,gBAAgB;IACnB,MAAM,CAAgB;IAE9B,YAAY,MAAqB;QAC/B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,QAAgB,EAAE,IAAS;QACvC,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;YAC/D,OAAO,QAAQ,CAAC;QAClB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,KAAK,YAAY,KAAK,IAAI,KAAK,CAAC,OAAO,KAAK,iBAAiB,EAAE,CAAC;gBAClE,MAAM,IAAI,KAAK,CACb,gGAAgG,CACjG,CAAC;YACJ,CAAC;YACD,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;CACF"}

package/package.json

@@ -0,0 +1,69 @@
+{
+  "name": "rbxstudio-mcp",
+  "version": "1.9.0",
+  "description": "MCP Server for Roblox Studio Integration - Access Studio data, scripts, and objects through AI tools",
+  "main": "dist/index.js",
+  "type": "module",
+  "bin": {
+    "rbxstudio-mcp": "dist/index.js"
+  },
+  "files": [
+    "dist/**/*",
+    "studio-plugin/**/*",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsx src/index.ts",
+    "start": "node dist/index.js",
+    "lint": "eslint src/**/*.ts",
+    "typecheck": "tsc --noEmit",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "test:coverage": "jest --coverage",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "mcp",
+    "roblox",
+    "studio",
+    "ai",
+    "model-context-protocol",
+    "game-development"
+  ],
+  "author": "",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/boshyxd/robloxstudio-mcp.git"
+  },
+  "homepage": "https://github.com/boshyxd/robloxstudio-mcp#readme",
+  "bugs": {
+    "url": "https://github.com/boshyxd/robloxstudio-mcp/issues"
+  },
+  "dependencies": {
+    "@modelcontextprotocol/sdk": "^0.6.0",
+    "cors": "^2.8.5",
+    "express": "^4.18.2",
+    "node-fetch": "^3.3.2",
+    "uuid": "^9.0.1",
+    "ws": "^8.14.2"
+  },
+  "devDependencies": {
+    "@types/cors": "^2.8.17",
+    "@types/express": "^4.17.21",
+    "@types/jest": "^29.5.11",
+    "@types/node": "^20.10.0",
+    "@types/supertest": "^6.0.2",
+    "@types/uuid": "^9.0.7",
+    "@types/ws": "^8.5.10",
+    "@typescript-eslint/eslint-plugin": "^7.0.0",
+    "@typescript-eslint/parser": "^7.0.0",
+    "eslint": "^8.57.0",
+    "jest": "^29.7.0",
+    "supertest": "^6.3.3",
+    "ts-jest": "^29.1.1",
+    "tsx": "^4.6.0",
+    "typescript": "^5.3.2"
+  }
+}

package/studio-plugin/INSTALLATION.md

@@ -0,0 +1,150 @@
+# Roblox Studio MCP Plugin Installation Guide
+
+Complete your AI assistant integration with this easy-to-install Studio plugin. Works with Claude Code, Claude Desktop, and any MCP-compatible AI.
+
+## 🚀 Quick Installation
+
+### **Method 1: Roblox Creator Store** ⭐ (Easiest)
+1. **Install from Creator Store:**
+   - Visit: https://create.roblox.com/store/asset/132985143757536
+   - Click **"Install"** button
+   - Plugin automatically opens in Studio
+
+2. **No restart needed** - Plugin appears immediately in toolbar!
+
+### **Method 2: Direct Download**
+1. **Download the plugin:**
+   - **GitHub Release**: [Download MCPPlugin.rbxmx](https://github.com/boshyxd/robloxstudio-mcp/releases/latest/download/MCPPlugin.rbxmx)
+   - This is the official Roblox plugin format
+
+2. **Install to plugins folder:**
+   - **Windows**: Save to `%LOCALAPPDATA%/Roblox/Plugins/`
+   - **macOS**: Save to `~/Documents/Roblox/Plugins/`
+   - **Or use Studio**: Plugins tab → Plugins Folder → drop the file
+
+3. **Restart Roblox Studio** - Plugin appears automatically!
+
+### **Method 3: Save as Local Plugin**
+1. **Copy the plugin code:**
+   - Open [plugin.luau](https://github.com/boshyxd/robloxstudio-mcp/blob/main/studio-plugin/plugin.luau) on GitHub
+   - Copy all the code (Ctrl+A, Ctrl+C)
+
+2. **Create in Studio:**
+   - Open Roblox Studio with any place
+   - Create a new Script in ServerScriptService  
+   - Paste the plugin code
+   - **Right-click script** → **"Save as Local Plugin..."**
+   - Name it "Roblox Studio MCP"
+
+3. **Plugin appears immediately** in your toolbar!
+
+## ⚙️ Setup & Configuration
+
+### **1. Enable HTTP Requests (Required)**
+🔐 **Game Settings** → **Security** → ✅ **"Allow HTTP Requests"**
+
+### **2. Activate the Plugin**
+🔘 **Plugins toolbar** → Click **"MCP Server"** button
+- 🟢 **Green status** = Connected and ready
+- 🔴 **Red status** = Disconnected (normal until MCP server runs)
+
+### **3. Install MCP Server** 
+Choose your AI assistant:
+
+**For Claude Code:**
+```bash
+claude mcp add robloxstudio-mcp
+```
+
+**For Claude Desktop/Others:**
+```json
+{
+  "mcpServers": {
+    "robloxstudio-mcp": {
+      "command": "npx",
+      "args": ["-y", "robloxstudio-mcp"]
+    }
+  }
+}
+```
+
+<details>
+<summary>Note for native Windows users</summary>
+If you encounter issues, you may need to run it through `cmd`. Update your configuration like this:
+
+```json
+{
+  "mcpServers": {
+    "robloxstudio-mcp": {
+      "command": "cmd",
+      "args": ["/c", "npx", "-y", "robloxstudio-mcp@latest"]
+    }
+  }
+}
+```
+</details>
+
+## 🎯 How It Works
+
+1. **🤖 AI calls tool** → MCP server queues request
+2. **🔄 Plugin polls** every 500ms for work
+3. **⚙️ Plugin executes** Studio API calls  
+4. **📤 Plugin responds** with extracted data
+5. **✅ AI receives** comprehensive Studio information
+
+**Available Tools:** 15 specialized tools for file trees, dependencies, properties, project structure, and more!
+
+## 🔧 Troubleshooting
+
+### **Plugin Missing from Toolbar**
+- ✅ Verify file saved to correct plugins folder
+- 🔄 Restart Roblox Studio completely
+- 📝 Check Output window for error messages
+
+### **"HTTP 403 Forbidden" Errors**  
+- ✅ Enable "Allow HTTP Requests" in Game Settings → Security
+- 🔍 Verify MCP server is running (status should show connected)
+
+### **Plugin Shows "Disconnected"**
+- ✅ **Normal behavior** when MCP server isn't running
+- 🔘 Click "MCP Server" button to activate
+- 📡 Install MCP server using commands above
+
+### **Connection Issues**
+- 🔥 Check Windows Firewall isn't blocking localhost:3002
+- 🖥️ Restart both Studio and your AI assistant
+- 📝 Check Studio Output window for detailed error messages
+
+## 🔒 Security & Privacy
+
+- 🏠 **Local-only**: All communication stays on your machine
+- 🚫 **No external servers**: Plugin only talks to localhost
+- 👁️ **Read-only access**: Plugin extracts data but never modifies your place
+- 🔐 **No data collection**: Your projects remain private
+
+## 🛠️ Advanced Usage
+
+### **Plugin Features**
+- **Real-time status**: Visual connection indicators
+- **Smart polling**: Exponential backoff for failed connections  
+- **Error recovery**: Automatic retry with timeout handling
+- **Debug friendly**: Comprehensive logging in Output window
+
+### **Customization**
+- 📝 **Server URL**: Modify in plugin UI (default: http://localhost:3002)
+- ⏱️ **Poll interval**: 500ms default (editable in code)
+- 🔧 **Timeout settings**: 30-second request timeouts
+
+### **Development Mode**
+```lua
+-- Enable debug logging in plugin code:
+local DEBUG_MODE = true
+```
+
+## 💡 Pro Tips
+
+- 🖥️ **Keep Studio open** while using AI assistants
+- 🔄 **Plugin auto-connects** when MCP server starts
+- 📊 **Monitor status** via the dock widget
+- 🎯 **Use AI tools** to explore game architecture, find bugs, analyze dependencies
+- 🚀 **Perfect for** code reviews, debugging, and understanding complex projects!