roblox-inspector-mcp
v1.0.0
Published
Read-only MCP Server for inspecting Roblox Studio properties, paths, and objects - No script access
Maintainers
Readme
Roblox Inspector MCP
A read-only MCP (Model Context Protocol) server for inspecting Roblox Studio properties, paths, and objects. This is a lightweight alternative to robloxstudio-mcp that focuses purely on inspection without any script or modification capabilities.
Purpose
This MCP server is designed for workflows where you need AI to:
- Get instance properties (Position, Size, Color, Transparency, etc.)
- Navigate the game hierarchy (find paths to objects)
- Search for objects by name, class, or property values
- Inspect UI elements, models, and hard-coded values
- Read attributes and tags
It does NOT provide:
- Script reading or editing
- Property modification
- Object creation/deletion
- Any write operations
Available Tools (15 total)
Hierarchy & Navigation
| Tool | Description |
|------|-------------|
| get_file_tree | Get complete project hierarchy with models, folders, and UI elements |
| get_project_structure | Get game hierarchy with configurable depth (use 5-10 for thorough exploration) |
| get_instance_children | Get child objects and their types for navigation |
Search Tools
| Tool | Description |
|------|-------------|
| search_files | Find instances by name or type patterns |
| search_objects | Find instances by name, class, or properties |
| search_by_property | Find objects with specific property values |
Property Inspection
| Tool | Description |
|------|-------------|
| get_instance_properties | Get all properties of a specific instance |
| mass_get_property | Get the same property from multiple instances at once |
Attribute Inspection
| Tool | Description |
|------|-------------|
| get_attribute | Get a single attribute value from an instance |
| get_attributes | Get all attributes on an instance |
Tag Inspection
| Tool | Description |
|------|-------------|
| get_tags | Get all tags on an instance |
| get_tagged | Get all instances with a specific tag |
Studio Context
| Tool | Description |
|------|-------------|
| get_place_info | Get place ID, name, and game settings |
| get_services | Get available Roblox services and their children |
| get_class_info | Get available properties/methods for Roblox classes |
Installation
1. Install the MCP Server
npm install -g roblox-inspector-mcpOr use npx directly in your MCP configuration.
2. Install the Studio Plugin
Copy studio-plugin/MCPPlugin.rbxmx to your Roblox Studio plugins folder:
- Windows:
%LOCALAPPDATA%\Roblox\Plugins\ - Mac:
~/Documents/Roblox/Plugins/
Or install from the source:
- Open Roblox Studio
- Go to View > Explorer
- Right-click on
ServerStorageor any location - Select "Insert from File" and choose
MCPPlugin.rbxmx - Move it to
ServerStorageor run as a plugin
3. Configure Your MCP Client
Add to your Claude Desktop or other MCP client configuration:
{
"mcpServers": {
"roblox-inspector": {
"command": "npx",
"args": ["-y", "roblox-inspector-mcp"]
}
}
}Or if installed globally:
{
"mcpServers": {
"roblox-inspector": {
"command": "roblox-inspector-mcp"
}
}
}Usage Examples
Get all properties of a Part
Use get_instance_properties with path "game.Workspace.MyPart"Find all TextLabels in the game
Use search_objects with query "TextLabel" and searchType "class"Get the Position of multiple parts
Use mass_get_property with paths ["game.Workspace.Part1", "game.Workspace.Part2"] and propertyName "Position"Find all objects with a specific tag
Use get_tagged with tagName "Interactable"Explore the game hierarchy
Use get_project_structure with maxDepth 8 for comprehensive explorationArchitecture
AI Tool Call → MCP Server (Node.js) → HTTP Bridge → Roblox Studio Plugin → Roblox APIThe server uses the same bridge architecture as robloxstudio-mcp, so both can share the same Studio plugin. The inspector version simply exposes a smaller, read-only subset of tools.
Environment Variables
| Variable | Default | Description |
|----------|---------|-------------|
| ROBLOX_STUDIO_PORT | 3002 | HTTP bridge port |
| ROBLOX_STUDIO_HOST | 0.0.0.0 | HTTP bridge host |
Compatibility
- Uses the same Studio plugin as robloxstudio-mcp
- Both servers can coexist (just run them on different ports)
- Node.js 18+ required
Why Use This Instead of robloxstudio-mcp?
Use roblox-inspector-mcp when:
- You only need to read/inspect properties
- You want to prevent accidental modifications
- You're building a workflow that shouldn't have write access
- You want a smaller tool surface for your AI
Use robloxstudio-mcp when:
- You need to modify scripts
- You need to create/delete objects
- You need full read-write access
License
MIT
