INSTALLATION.mdā¢4.94 kB
# 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!