rbxmcp
by xrimce
README.md
# ⚡ Roblox Dex MCP Server (`rbxmcp`)
A comprehensive **Model Context Protocol (MCP)** server bringing the complete power of **Dark Dex Explorer & Properties, Dex Console, Script Decompiler, 3D Spatial Inspector, Cobalt Remote Spy & Network Interceptor, and Executor Environment Tools** to your MCP clients (Claude Desktop, Cursor, Antigravity, etc.).
---
## 🚀 Quick Start
### 1. Start the MCP Server
```bash
python3 start.py
```
*(Or run standalone web dashboard with `python3 start.py --bridge-only`)*
### 2. Connect Your Roblox Game
Execute this one-liner in your Roblox executor (Synapse, Wave, Delta, Solara, Krnl, Fluxus, Arceus X, Codex, Studio, etc.):
```lua
loadstring(game:HttpGet("http://127.0.0.1:8765/client.lua"))()
```
---
## 🛠️ Complete 51 MCP Tools Reference
### 💻 1. Console, Logs & Performance
- **`dex_get_console_logs`**: Retrieve Roblox client console logs (`LogService:GetLogHistory()`) with type filtering (`all`, `Output`, `Info`, `Warning`, `Error`) and keyword search.
- **`dex_clear_console_logs`**: Clear the console history log buffer.
- **`dex_get_performance_stats`**: Detailed memory breakdown by category (`Physics`, `Textures`, `Meshes`, `Gui`, `Sounds`, `Instances`, `LuaHeap`, `Scripts`), FPS, Ping, and Network throughput.
### 📡 2. Cobalt Remote Spy & Network Interceptor
- **`dex_start_remote_listener`**: Start or resume active two-way network interception (outgoing `FireServer`/`InvokeServer` and incoming `OnClientEvent`/`Event`).
- **`dex_stop_remote_listener`**: Pause / stop the active Remote Spy listener.
- **`dex_get_remote_logs`**: Fetch structured intercepted network logs with caller script, line number, closure type, and serialized arguments.
- **`dex_clear_remote_logs`**: Clear the in-memory Remote Spy call history buffer.
- **`dex_generate_remote_code`**: Generate clean, runnable Luau code (`call` reproduction script or `hook` metamethod template) for any logged remote event.
- **`dex_block_remote`** / **`dex_unblock_remote`**: Block or unblock specific remotes from sending traffic across the network.
- **`dex_ignore_remote`** / **`dex_unignore_remote`**: Ignore specific spammy remotes from cluttering the spy logs.
- **`dex_replay_remote`**: Replay / re-fire an intercepted remote call using its exact recorded arguments.
- **`dex_bypass_anticheat`**: Detect and bypass client-side anticheats (e.g. Adonis Anti-Cheat).
- **`dex_list_remotes`**: Discover all `RemoteEvent`, `RemoteFunction`, and `UnreliableRemoteEvent` instances.
- **`dex_fire_remote`**: Fire or invoke remote events/functions with custom arguments.
### 🌳 3. Explorer & Hierarchy Navigation
- **`dex_get_hierarchy`**: Tree-view explorer with configurable depth, max child limits, and class names (Dark Dex Explorer).
- **`dex_find_parts`**: Search instances by name pattern (glob/fuzzy) and class name.
- **`dex_get_part_location`**: Exact 3D bounding box, `Position`, `Orientation`, `CFrame`, `Size`, `Mass`, `AssemblyLinearVelocity`, and collision flags.
- **`dex_get_instance_path`**: Find the full hierarchical path string of any named instance.
- **`dex_clone_instance`**: Deep clone any Instance and reparent it.
- **`dex_rename_instance`**: Rename an instance dynamically.
- **`dex_reparent_instance`**: Move instances across the hierarchy.
- **`dex_clear_children`**: Delete children of an instance with optional class filter.
- **`dex_get_nil_instances`**: Scan and return instances parented to `nil` (`getnilinstances()`).
### ⚙️ 4. Properties, Attributes & Tags
- **`dex_get_properties`**: Full property reflection matching Dex Properties Window with type serialization (`Vector3`, `CFrame`, `Color3`, `BrickColor`, `Enum`, `UDim2`, etc.).
- **`dex_set_properties`**: Modify multiple properties on an instance with automated type conversion.
- **`dex_get_attributes`**: Read all user-defined attributes on an instance.
- **`dex_set_attribute`**: Create or update attributes.
- **`dex_add_tag`** / **`dex_remove_tag`**: Add or remove `CollectionService` tags.
- **`dex_get_tagged_instances`**: Retrieve all instances with a specific tag.
### 📜 5. Script Viewer, Decompiler & Bytecode
- **`dex_list_scripts`**: List all `LocalScript` and `ModuleScript` instances with parent containers and enabled states.
- **`dex_decompile_script`**: Decompile and view the Luau source code of any script or module.
- **`dex_require_module`**: Require a `ModuleScript` in runtime and inspect returned tables and functions.
- **`dex_get_running_scripts`**: Query active threads in the Lua VM via `getrunningscripts()`.
- **`dex_get_loaded_modules`**: List all cached modules using `getloadedmodules()`.
### 🎯 6. World Interactions, Teleportation & Visuals
- **`dex_fire_click_detector`**: Trigger `ClickDetector` clicks at any distance.
- **`dex_fire_proximity_prompt`**: Instantly trigger `ProximityPrompt` without holding.
- **`dex_fire_touch_interest`**: Simulate physical touch between two parts.
- **`dex_teleport_player`**: Safely teleport the local player to any Part, Model, Player, or coordinates.
- **`dex_get_players`**: List players with health, team, position, and inventory data.
- **`dex_highlight_instance`**: Draw 3D bounding highlight boxes around instances.
- **`dex_get_game_info`**: Retrieve Place ID, Job ID, Universe ID, Game Name, and Creator info.
- **`dex_save_instance`**: Save game/model hierarchy to a `.rbxl` / `.rbxm` file using `saveinstance()`.
---
## 📄 License
MIT License. Inspired by Dark Dex V3 / Dex++ by Moon & Dex Developers, and Cobalt by notpoiu.
This server cannot be deployed
Maintenance
ActivityMaintained
ResponsivenessNo issues