@weppy/roblox-mcp 1.0.2 → 1.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -6,14 +6,14 @@
6
6
  },
7
7
  "metadata": {
8
8
  "description": "Roblox MCP server and tools for AI-powered game development",
9
- "version": "1.0.2"
9
+ "version": "1.0.3"
10
10
  },
11
11
  "plugins": [
12
12
  {
13
13
  "name": "weppy-roblox-mcp",
14
14
  "source": "./plugins/weppy-roblox-mcp",
15
15
  "description": "MCP server for Roblox Studio integration - 132 tools for AI-powered game development with specialized agents and skills",
16
- "version": "1.0.2",
16
+ "version": "1.0.3",
17
17
  "author": {
18
18
  "name": "hope1026"
19
19
  },
package/CHANGELOG.md CHANGED
@@ -7,6 +7,28 @@ All notable changes to this project will be documented in this file.
7
7
 
8
8
 
9
9
 
10
+
11
+ ## [1.0.3] - 2026-02-24
12
+
13
+ ### Features
14
+
15
+ - add restoreToken support for license management
16
+
17
+ ### Documentation
18
+
19
+ - update tool documentation to clarify sync actions and add `progress`
20
+
21
+ ### Chores
22
+
23
+ - add initial planning and task documents for manifest-driven codegen architecture
24
+ - remove unused license server deployment workflow and coverage reports
25
+
26
+ ### Other Changes
27
+
28
+ - refactor: remove FooterCard module and integrate reset/feedback functionality directly into SettingsTab
29
+ - refactor: centralize UI localization handling across MCP tab components
30
+
31
+
10
32
  ## [1.0.2] - 2026-02-23
11
33
 
12
34
  ### Bug Fixes
package/README.md CHANGED
@@ -6,67 +6,40 @@
6
6
 
7
7
  [![Demo](https://img.youtube.com/vi/3jrUpBbZPaw/maxresdefault.jpg)](https://youtu.be/3jrUpBbZPaw)
8
8
 
9
- ## What You Can Do
9
+ ## Core Capabilities
10
10
 
11
- ### From One Idea to a Playable Game
11
+ ### 1) MCP Tools: Direct execution in Studio from natural language
12
12
 
13
- "Make a Minecraft-style survival game with day/night, crafting, and wave defense." — One sentence and AI designs the game structure, builds the map, creates objects, and writes every script.
13
+ The first pillar of Roblox MCP is **MCP tool execution**.
14
+ AI can directly handle scripts, instances, properties, terrain, lighting, assets, audio, and animation inside Studio.
14
15
 
15
- > **Tip**: Ask "Make a plan first", review it, then say "Execute it" for better results.
16
+ - "Add particles + sound + cooldown when the player jumps."
17
+ - "Build a boss arena at map center and place collision-safe spawn points."
18
+ - "Change this module interface and update every dependent script."
16
19
 
17
- ### An AI That Has Read Your Entire Project
20
+ This is not just code generation. It is **executable, production-oriented actions**.
18
21
 
19
- AI syncs your Roblox project to local files, learning every script, object, and structure. Dozens of files understood at once, changed consistently.
22
+ ### 2) Sync: Keep full project context stable for AI
20
23
 
21
- - "Find every place that uses RemoteEvents and map out the call flow."
22
- - "Refactor all enemy AI scripts to use a unified state machine."
23
- - "Summarize only the risky changes made since yesterday."
24
+ The second pillar is **Project Sync**.
25
+ AI works from a synchronized local mirror, so multi-file updates stay consistent.
24
26
 
25
- Manage multiple Places simultaneously. Track the full history of changes.
27
+ - Basic: one-way sync (Studio -> Local)
28
+ - Pro: bidirectional sync + per-type Direction/Apply Mode + history + multi-place
26
29
 
27
- ### Scripts: Write, Refactor, Debug Across Related Files
30
+ You keep source-of-truth clear and avoid losing change context.
28
31
 
29
- Not just the file you point at. AI handles the whole dependency chain.
32
+ ## Immediate Value
30
33
 
31
- - "When the player jumps, add particles, a sound, and a cooldown."
32
- - "Find all event connections that could leak memory and fix them safely."
33
- - "Change this module's interface and update every script that references it."
34
+ - Compress repetitive work: turn many manual edits into one request
35
+ - Change related files together: not just one target file
36
+ - Lower risk: rely on sync state and history before applying changes
37
+ - Better token efficiency (Pro): reduce round trips with bulk actions
34
38
 
35
- ### Build and Place Objects — Hundreds at Once
39
+ ## Detailed Docs
36
40
 
37
- "Line up 50 street lights along this road", "Place 20 brick houses across the district with random rotations" — AI creates them directly in Studio. Batch-update properties across any number of objects with a single command.
38
-
39
- ### Lighting, Weather, and Atmosphere in One Sentence
40
-
41
- "Change to a dusty desert at sunset", "Make it a stormy night where lightning briefly illuminates the area" — one sentence and lighting, sky, atmosphere, and fog all update at once.
42
-
43
- ### Sculpt Terrain Through Conversation
44
-
45
- "Mountains in the north, a river through the center, open plains in the south" — generate any landscape through conversation. Control material, color, height, and smoothing. Build entire maps without touching the terrain editor.
46
-
47
- ### Search Creator Store and Place Instantly
48
-
49
- "Find a medieval castle model, place it at the map center, and scale it up 1.5x" — search free assets and insert them directly into your project.
50
-
51
- ### Spatial Intelligence for Level Design
52
-
53
- "Find open space for a new boss arena", "Show only the areas where monsters can actually patrol" — AI handles complex spatial reasoning and placement logic.
54
-
55
- ### Animations, Physics, and Audio as Connected Systems
56
-
57
- - "While the dash animation plays, change the player-enemy collision rules."
58
- - "Fade in the boss BGM when the ultimate activates, and smoothly return when it ends."
59
-
60
- Characters, collision, and sound working together as a game system, not separate tools.
61
-
62
- ### Run Any Roblox Code Directly
63
-
64
- When built-in tools aren't enough, AI executes arbitrary Luau in Studio.
65
-
66
- - "Find every Part in the Workspace with Anchored=false and list them."
67
- - "Batch-update matching objects and log every change."
68
-
69
- > [View all tools](docs/en/tools/overview.md)
41
+ - [Tools Overview](docs/en/tools/overview.md)
42
+ - [Sync Deep Dive](docs/en/sync/overview.md)
70
43
 
71
44
  ## Getting Started
72
45
 
@@ -0,0 +1,104 @@
1
+ # Roblox MCP Sync Deep Dive
2
+
3
+ Sync connects Roblox Studio state and local files so AI can read and modify the full project context reliably.
4
+
5
+ ## Why Sync matters
6
+
7
+ Without Sync, AI only sees snippets pasted into chat. With Sync enabled, AI works from the whole project.
8
+
9
+ - Apply refactors consistently across multiple scripts
10
+ - Review risky changes quickly using history
11
+ - Keep source-of-truth clear between Studio and local files
12
+
13
+ ## How it works
14
+
15
+ 1. Full Sync: initial mirror from Studio tree/instances to local files
16
+ 2. Incremental Sync: continuous update of new changes
17
+ 3. History/Status tracking: inspect what changed, when, and in which direction
18
+
19
+ Default local path is `roblox-project-sync/place_{placeId}/explorer`.
20
+
21
+ ## Basic vs Pro
22
+
23
+ | Item | Basic | Pro |
24
+ |------|------|-----|
25
+ | Sync direction | Studio -> Local | Bidirectional |
26
+ | Per-type Direction | Not supported | Supported (Scripts / Values / Containers / Data / Services) |
27
+ | Per-type Apply Mode | Not supported | Supported (Auto / Manual) |
28
+ | Status/history APIs | Not supported | Supported (`status`, `history`, `progress`) |
29
+ | `manage_sync` tool | Not supported | Supported |
30
+ | Multi-place sync | Not supported | Supported (up to 3 places) |
31
+
32
+ ## Sync targets and default exclusions
33
+
34
+ Default syncable services:
35
+
36
+ - `Workspace`
37
+ - `Lighting`
38
+ - `ReplicatedStorage`
39
+ - `ServerStorage`
40
+ - `ServerScriptService`
41
+ - `StarterGui`
42
+ - `StarterPlayer`
43
+ - `StarterPack`
44
+ - `ReplicatedFirst`
45
+ - `SoundService`
46
+ - `Chat`
47
+ - `LocalizationService`
48
+
49
+ Default exclusions:
50
+
51
+ - Classes: `Terrain`, `Camera`
52
+ - Security-restricted paths: `CoreGui`, `CorePackages`, `RobloxScript`, `RobloxScriptSecurity`
53
+
54
+ ## Direction and Apply Mode
55
+
56
+ ### Direction (per-type sync direction)
57
+
58
+ - `forward`: Studio -> Local
59
+ - `reverse`: Local -> Studio
60
+ - `bidirectional`: both directions
61
+
62
+ Types are managed separately: `scripts`, `values`, `containers`, `data`, `services`.
63
+
64
+ ### Apply Mode (how reverse changes are applied)
65
+
66
+ - `manual`: user confirms before applying to Studio
67
+ - `auto`: detected changes are auto-applied
68
+
69
+ In Pro, Direction and Apply Mode can be controlled per type.
70
+
71
+ ## `manage_sync` action guide (Pro)
72
+
73
+ | Action | Description | Key params |
74
+ |------|------|-----------|
75
+ | `status` | Check current sync state for a place | `placeId` |
76
+ | `config` | Get sync configuration | `placeId` |
77
+ | `history` | Query change history | `placeId`, `query.limit`, `query.offset` |
78
+ | `directions` | Get per-type direction settings | `placeId` |
79
+ | `read_file` | Read a synced file | `placeId`, `instancePath` |
80
+ | `write_file` | Write a synced file | `placeId`, `instancePath`, `content` |
81
+ | `progress` | Get realtime sync progress/throughput | `placeId` |
82
+
83
+ ## Recommended workflow
84
+
85
+ ### 1) Start safely
86
+
87
+ - Complete Full Sync first to establish a stable baseline
88
+ - Start with `manual` apply mode to reduce risk
89
+
90
+ ### 2) Work with AI
91
+
92
+ - "Check sync status, then summarize only risky changes from recent history"
93
+ - "Refactor scripts in `ServerScriptService` first and include history output"
94
+
95
+ ### 3) Recover when needed
96
+
97
+ - Track recent entries with `history`
98
+ - Inspect target file with `read_file`
99
+ - Restore content with `write_file`, then verify Studio state
100
+
101
+ ## Related docs
102
+
103
+ - [Tools Overview](../tools/overview.md)
104
+ - [Pro Upgrade Guide](../pro-upgrade.md)
@@ -2,6 +2,9 @@
2
2
 
3
3
  For detailed parameters, check MCP tool definitions directly.
4
4
 
5
+ Related docs:
6
+ - [Sync Deep Dive](../sync/overview.md)
7
+
5
8
  Sync policy:
6
9
  - Basic: Studio -> Local one-way sync
7
10
  - Pro: Bidirectional sync + broader advanced action coverage (better AI token efficiency with bulk workflows)
@@ -211,11 +214,12 @@ Sync policy:
211
214
  | Action | Description | Tier |
212
215
  |--------|-------------|------|
213
216
  | `status` | Get sync status for a place | Pro |
214
- | `config` | Get/set sync configuration | Pro |
217
+ | `config` | Get sync configuration | Pro |
215
218
  | `history` | Get change history | Pro |
216
- | `directions` | Get/set per-type sync directions | Pro |
219
+ | `directions` | Get per-type sync directions | Pro |
217
220
  | `read_file` | Read a synced file | Pro |
218
221
  | `write_file` | Write to a synced file | Pro |
222
+ | `progress` | Get real-time sync progress and bandwidth | Pro |
219
223
 
220
224
  ## Workspace State (Pro)
221
225
 
package/docs/es/README.md CHANGED
@@ -6,82 +6,55 @@
6
6
 
7
7
  [![Demo](https://img.youtube.com/vi/3jrUpBbZPaw/maxresdefault.jpg)](https://youtu.be/3jrUpBbZPaw)
8
8
 
9
- ## Qué puedes hacer
9
+ ## Funciones principales
10
10
 
11
- ### De una idea a un juego jugable
11
+ ### 1) MCP Tool: ejecuta en Studio desde lenguaje natural
12
12
 
13
- "Crea un juego de supervivencia estilo Minecraft con ciclo día/noche, recolección, crafteo y defensa de oleadas." — Una frase y la IA diseña la estructura, construye el mapa, crea los objetos y escribe todos los scripts.
13
+ El primer eje de Roblox MCP es la **ejecucion de MCP Tool**.
14
+ La IA puede manejar directamente scripts, instancias, propiedades, terreno, iluminacion, assets, audio y animacion dentro de Studio.
14
15
 
15
- > **Tip**: Pide primero "Haz un plan", revísalo y luego di "Ejecútalo" para obtener mejores resultados.
16
+ - "Agrega particulas + sonido + cooldown cuando el jugador salte."
17
+ - "Crea una arena de boss en el centro del mapa y coloca spawns sin colision."
18
+ - "Cambia la interfaz de este modulo y actualiza todos los scripts dependientes."
16
19
 
17
- ### Una IA que ha leído todo tu proyecto
20
+ No es solo generacion de codigo. Son **acciones ejecutables orientadas a produccion**.
18
21
 
19
- La IA sincroniza tu proyecto de Roblox en archivos locales y aprende cada script, objeto y estructura. Docenas de archivos entendidos a la vez, modificados de forma consistente.
22
+ ### 2) Sync: mantiene el contexto completo del proyecto
20
23
 
21
- - "Encuentra todos los lugares que usan RemoteEvents y mapea el flujo de llamadas."
22
- - "Refactoriza todos los scripts de IA enemiga para usar una máquina de estados unificada."
23
- - "Resume solo los cambios peligrosos realizados desde ayer."
24
+ El segundo eje es **Project Sync**.
25
+ La IA trabaja sobre un espejo local sincronizado, asi que los cambios en multiples archivos se mantienen consistentes.
24
26
 
25
- Gestiona múltiples Places simultáneamente. Rastrea el historial completo de cambios.
27
+ - Basic: sincronizacion unidireccional (Studio -> Local)
28
+ - Pro: sincronizacion bidireccional + Direction/Apply Mode por tipo + historial + multiplace
26
29
 
27
- ### Scripts: escribir, refactorizar, depurar en archivos relacionados a la vez
30
+ Asi mantienes claro cual es la fuente de verdad y no pierdes contexto de cambios.
28
31
 
29
- No solo el archivo que señalas. La IA maneja toda la cadena de dependencias.
32
+ ## Valor inmediato para el usuario
30
33
 
31
- - "Cuando el jugador salte, agrega partículas, sonido y cooldown."
32
- - "Encuentra todas las conexiones de eventos que podrían tener memory leaks y corrígelas de forma segura."
33
- - "Cambia la interfaz de este módulo y actualiza todos los scripts que lo referencian."
34
+ - Comprime trabajo repetitivo: convierte muchas ediciones manuales en una sola instruccion
35
+ - Cambios relacionados en conjunto: no solo un archivo aislado
36
+ - Menor riesgo: decide cambios con estado de sync e historial
37
+ - Mejor eficiencia de tokens (Pro): menos idas y vueltas con acciones masivas
34
38
 
35
- ### Crear y colocar objetos — cientos con un solo comando
39
+ ## Documentacion detallada
36
40
 
37
- "Alinea 50 farolas a lo largo de esta carretera", "Coloca 20 casas de ladrillo por el distrito con rotaciones aleatorias" — la IA los crea directamente en Studio. Actualiza propiedades en cualquier número de objetos con un solo comando.
38
-
39
- ### Iluminación, clima y atmósfera en una frase
40
-
41
- "Cambia a un desierto polvoriento al atardecer", "Hazlo una noche tormentosa donde los relámpagos iluminen brevemente el área" — una frase y la iluminación, el cielo, la atmósfera y la niebla se actualizan al mismo tiempo.
42
-
43
- ### Esculpe terreno a través de la conversación
44
-
45
- "Montañas al norte, un río en el centro, llanuras abiertas al sur" — genera cualquier paisaje conversando. Controla material, color, altura y suavizado. Construye mapas enteros sin tocar el editor de terreno.
46
-
47
- ### Busca en Creator Store y coloca al instante
48
-
49
- "Encuentra un modelo de castillo medieval, colócalo en el centro del mapa y escálalo 1.5x" — busca assets gratuitos e insértalos directamente en tu proyecto.
50
-
51
- ### Inteligencia espacial para el diseño de niveles
52
-
53
- "Encuentra espacio abierto para una nueva arena del jefe", "Muestra solo las áreas donde los monstruos realmente pueden patrullar" — la IA maneja el razonamiento espacial complejo y la lógica de colocación.
54
-
55
- ### Animaciones, física y audio como sistemas conectados
56
-
57
- - "Mientras se reproduce la animación de dash, cambia las reglas de colisión jugador-enemigo."
58
- - "Haz fade in del BGM del jefe cuando se activa el ultimate, y vuelve suavemente cuando termina."
59
-
60
- Personajes, colisión y sonido trabajando juntos como sistema de juego, no como herramientas separadas.
61
-
62
- ### Ejecuta cualquier código de Roblox directamente
63
-
64
- Cuando las herramientas integradas no son suficientes, la IA ejecuta Luau arbitrario en Studio.
65
-
66
- - "Encuentra todas las Parts en el Workspace con Anchored=false y listarlas."
67
- - "Actualiza en lote los objetos coincidentes y registra cada cambio."
68
-
69
- > [Ver todas las herramientas](tools/overview.md)
41
+ - [Cobertura de herramientas (Tools Overview)](tools/overview.md)
42
+ - [Guia detallada de Sync](sync/overview.md)
70
43
 
71
44
  ## Comenzar
72
45
 
73
- La instalación se completa en dos pasos:
46
+ La instalacion se completa en dos pasos:
74
47
 
75
48
  1. **Instalar el plugin de Roblox Studio** — Hace de puente entre Studio e IA
76
49
  2. **Registrar el servidor MCP en tu app de IA** — Para que la app de IA lo reconozca
77
50
 
78
- Solo toma 5 minutos. 👉 [Ver guía de instalación](installation/README.md)
51
+ Solo toma 5 minutos. 👉 [Ver guia de instalacion](installation/README.md)
79
52
 
80
53
  ## Upgrade Pro
81
54
 
82
- Sync bidireccional, capacidades de creación avanzadas y eficiencia de tokens de IA — todo en una sola actualización.
55
+ Sync bidireccional, capacidades de creacion avanzadas y eficiencia de tokens de IA — todo en una sola actualizacion.
83
56
 
84
- 👉 [Guía de actualización Pro](pro-upgrade.md)
57
+ 👉 [Guia de actualizacion Pro](pro-upgrade.md)
85
58
 
86
59
  ## Enlaces
87
60
 
@@ -0,0 +1,104 @@
1
+ # Guia detallada de Sync en Roblox MCP
2
+
3
+ Sync conecta el estado de Roblox Studio con archivos locales para que la IA pueda leer y modificar el contexto completo del proyecto de forma confiable.
4
+
5
+ ## Por que Sync es importante
6
+
7
+ Sin Sync, la IA solo ve fragmentos pegados en el chat. Con Sync activo, trabaja sobre todo el proyecto.
8
+
9
+ - Aplicar refactors de forma consistente en multiples scripts
10
+ - Revisar cambios riesgosos rapidamente usando historial
11
+ - Mantener clara la fuente de verdad entre Studio y archivos locales
12
+
13
+ ## Como funciona
14
+
15
+ 1. Full Sync: espejo inicial del arbol/instancias de Studio a local
16
+ 2. Incremental Sync: reflejo continuo de cambios nuevos
17
+ 3. Seguimiento de History/Status: ver que cambio, cuando y en que direccion
18
+
19
+ La ruta local por defecto es `roblox-project-sync/place_{placeId}/explorer`.
20
+
21
+ ## Basic vs Pro
22
+
23
+ | Item | Basic | Pro |
24
+ |------|------|-----|
25
+ | Direccion de sync | Studio -> Local | Bidireccional |
26
+ | Direction por tipo | No soportado | Soportado (Scripts / Values / Containers / Data / Services) |
27
+ | Apply Mode por tipo | No soportado | Soportado (Auto / Manual) |
28
+ | APIs de estado/historial | No soportado | Soportado (`status`, `history`, `progress`) |
29
+ | Herramienta `manage_sync` | No soportado | Soportado |
30
+ | Sync multiplace | No soportado | Soportado (hasta 3 places) |
31
+
32
+ ## Objetivos de sync y exclusiones por defecto
33
+
34
+ Servicios sincronizables por defecto:
35
+
36
+ - `Workspace`
37
+ - `Lighting`
38
+ - `ReplicatedStorage`
39
+ - `ServerStorage`
40
+ - `ServerScriptService`
41
+ - `StarterGui`
42
+ - `StarterPlayer`
43
+ - `StarterPack`
44
+ - `ReplicatedFirst`
45
+ - `SoundService`
46
+ - `Chat`
47
+ - `LocalizationService`
48
+
49
+ Exclusiones por defecto:
50
+
51
+ - Clases: `Terrain`, `Camera`
52
+ - Rutas restringidas por seguridad: `CoreGui`, `CorePackages`, `RobloxScript`, `RobloxScriptSecurity`
53
+
54
+ ## Direction y Apply Mode
55
+
56
+ ### Direction (direccion por tipo)
57
+
58
+ - `forward`: Studio -> Local
59
+ - `reverse`: Local -> Studio
60
+ - `bidirectional`: ambas direcciones
61
+
62
+ Los tipos se gestionan por separado: `scripts`, `values`, `containers`, `data`, `services`.
63
+
64
+ ### Apply Mode (como se aplican cambios reverse)
65
+
66
+ - `manual`: el usuario confirma antes de aplicar a Studio
67
+ - `auto`: los cambios detectados se aplican automaticamente
68
+
69
+ En Pro puedes controlar Direction y Apply Mode por tipo.
70
+
71
+ ## Guia de acciones `manage_sync` (Pro)
72
+
73
+ | Accion | Descripcion | Parametros clave |
74
+ |------|------|-----------|
75
+ | `status` | Consultar estado actual de sync de un place | `placeId` |
76
+ | `config` | Obtener configuracion de sync | `placeId` |
77
+ | `history` | Consultar historial de cambios | `placeId`, `query.limit`, `query.offset` |
78
+ | `directions` | Obtener direcciones por tipo | `placeId` |
79
+ | `read_file` | Leer archivo sincronizado | `placeId`, `instancePath` |
80
+ | `write_file` | Escribir archivo sincronizado | `placeId`, `instancePath`, `content` |
81
+ | `progress` | Obtener progreso/throughput en tiempo real | `placeId` |
82
+
83
+ ## Flujo recomendado
84
+
85
+ ### 1) Empezar con seguridad
86
+
87
+ - Completa Full Sync primero para establecer una base estable
88
+ - Empieza con modo `manual` para reducir riesgo
89
+
90
+ ### 2) Trabajar con IA
91
+
92
+ - "Revisa el estado de sync y resume solo cambios riesgosos del historial reciente"
93
+ - "Refactoriza primero scripts de `ServerScriptService` y deja registro en historial"
94
+
95
+ ### 3) Recuperar cuando sea necesario
96
+
97
+ - Sigue cambios recientes con `history`
98
+ - Inspecciona archivo objetivo con `read_file`
99
+ - Restaura contenido con `write_file` y verifica en Studio
100
+
101
+ ## Documentos relacionados
102
+
103
+ - [Cobertura de herramientas (Tools Overview)](../tools/overview.md)
104
+ - [Guia de upgrade Pro](../pro-upgrade.md)