9c44cb514f
- MCP server with 12 tools for Roblox manipulation - WebSocket communication with Roblox Studio - Create scripts, parts, models, GUIs - Execute Lua code, control playtest - Full documentation and examples 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
70 lines
1.7 KiB
Markdown
70 lines
1.7 KiB
Markdown
# Roblox MCP - Quick Start Guide
|
|
|
|
## Step 1: Start the MCP Server
|
|
|
|
In this directory, run:
|
|
```bash
|
|
npm start
|
|
```
|
|
|
|
You should see:
|
|
```
|
|
HTTP server listening on port 37423
|
|
WebSocket server listening on port 37424
|
|
Waiting for Roblox Studio connection...
|
|
```
|
|
|
|
## Step 2: Install Roblox Studio Script
|
|
|
|
### Option A: Quick Install (Recommended)
|
|
1. Open Roblox Studio
|
|
2. In ServerScriptService, create a new Script
|
|
3. Copy the contents of `roblox-plugin/RobloxMCPServer.lua`
|
|
4. Paste into the script
|
|
5. Press Play
|
|
6. Look for the green "Roblox MCP Server" indicator in top-right
|
|
|
|
### Option B: Plugin Install
|
|
1. Copy `roblox-plugin/RobloxMCPPlugin.lua` to your Roblox Plugins folder:
|
|
- Windows: `C:\Users\YOUR_USERNAME\AppData\Local\Roblox\Plugins\`
|
|
2. Restart Roblox Studio
|
|
3. Enable via Plugin Management
|
|
|
|
## Step 3: Enable HTTP Requests
|
|
|
|
In Roblox Studio:
|
|
1. Game Settings → Security
|
|
2. Enable "Allow HTTP Requests"
|
|
3. Enable "Enable Studio Access to API Services"
|
|
|
|
## Step 4: Test with Claude Code
|
|
|
|
Now you can ask Claude to:
|
|
- "Create a red block part at position 0, 10, 0"
|
|
- "Create a Script in Workspace that prints hello"
|
|
- "Create a ScreenGui with a button"
|
|
|
|
## Troubleshooting
|
|
|
|
**Server won't start?**
|
|
- Check if port 37423/37424 is already in use
|
|
- Run `netstat -ano | findstr :37423` to check
|
|
|
|
**Roblox not connecting?**
|
|
- Make sure HTTP requests are enabled
|
|
- Check you pressed Play in Roblox Studio
|
|
- Look for the status indicator
|
|
|
|
**Commands not working?**
|
|
- Check Roblox Output window for errors
|
|
- Make sure paths are correct (e.g., "Workspace" not "workspace")
|
|
|
|
## Port Configuration
|
|
|
|
Default ports:
|
|
- MCP HTTP: 37423
|
|
- MCP WebSocket: 37424
|
|
- Roblox HTTP: 37425
|
|
|
|
Change in `src/index.js` and `roblox-plugin/RobloxMCPServer.lua` if needed.
|