@weppy/roblox-mcp 2.5.0 → 2.6.0

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.
Files changed (212) hide show
  1. package/.claude-plugin/marketplace.json +2 -2
  2. package/.github/workflows/install-test.yml +55 -4
  3. package/CHANGELOG.md +25 -0
  4. package/README.md +29 -45
  5. package/SUPPORT.md +4 -6
  6. package/docs/assets/screenshots/roblox-explorer/roblox-explorer-property-window.png +0 -0
  7. package/install.ps1 +22 -9
  8. package/install.sh +19 -4
  9. package/llms-full.txt +8 -688
  10. package/llms.txt +3 -13
  11. package/package.json +1 -1
  12. package/plugins/weppy-roblox-mcp/.claude-plugin/plugin.json +1 -1
  13. package/plugins/weppy-roblox-mcp/dashboard/dist/assets/{ChangelogDetailPage-DRfFUIvC.js → ChangelogDetailPage-C-ROvHGr.js} +1 -1
  14. package/plugins/weppy-roblox-mcp/dashboard/dist/assets/{ChangelogPage-Dgl8dBt6.js → ChangelogPage-CPm4ft8m.js} +1 -1
  15. package/plugins/weppy-roblox-mcp/dashboard/dist/assets/{ConfirmModal-DfdyAPrJ.js → ConfirmModal-BSTYLn14.js} +1 -1
  16. package/plugins/weppy-roblox-mcp/dashboard/dist/assets/{ConnectionPage-LSvSX1_u.js → ConnectionPage-BeJEgfmf.js} +1 -1
  17. package/plugins/weppy-roblox-mcp/dashboard/dist/assets/{InfoLabel-DrK7vhO-.js → InfoLabel-BRbbxjjt.js} +1 -1
  18. package/plugins/weppy-roblox-mcp/dashboard/dist/assets/{OverviewPage-CXsGuoPu.js → OverviewPage-BHd6yL_8.js} +1 -1
  19. package/plugins/weppy-roblox-mcp/dashboard/dist/assets/{PlaytestPage-CgkzRAqQ.js → PlaytestPage-BiNJCh4I.js} +1 -1
  20. package/plugins/weppy-roblox-mcp/dashboard/dist/assets/{PropertyDiff-Dy3MffNh.js → PropertyDiff-BKVe7m6g.js} +1 -1
  21. package/plugins/weppy-roblox-mcp/dashboard/dist/assets/SettingsPage-Cg33y021.js +1 -0
  22. package/plugins/weppy-roblox-mcp/dashboard/dist/assets/{StatusBadge-hJyzgRAl.js → StatusBadge-A72TDL-q.js} +1 -1
  23. package/plugins/weppy-roblox-mcp/dashboard/dist/assets/{SyncPage-eX2Rh-Ct.js → SyncPage-R4Qs9Xt3.js} +1 -1
  24. package/plugins/weppy-roblox-mcp/dashboard/dist/assets/TierComparison-CQewH4h_.js +1 -0
  25. package/plugins/weppy-roblox-mcp/dashboard/dist/assets/{TierPromoProgress-CLAr1gQq.js → TierPromoProgress-DolZjAqX.js} +1 -1
  26. package/plugins/weppy-roblox-mcp/dashboard/dist/assets/{ToolsPage-CqzfCxxH.js → ToolsPage-DRX93nSV.js} +1 -1
  27. package/plugins/weppy-roblox-mcp/dashboard/dist/assets/WhatsNewPage-uLdiNHd0.js +1 -0
  28. package/plugins/weppy-roblox-mcp/dashboard/dist/assets/{index-BfvSPSNj.js → index-oz4Gtzz9.js} +55 -21
  29. package/plugins/weppy-roblox-mcp/dashboard/dist/assets/{useLiveUptime-BeRNzFBh.js → useLiveUptime-CRLLCM8t.js} +1 -1
  30. package/plugins/weppy-roblox-mcp/dashboard/dist/index.html +1 -1
  31. package/plugins/weppy-roblox-mcp/dashboard/dist/weppy-icon.png +0 -0
  32. package/plugins/weppy-roblox-mcp/dist/index.js +76 -76
  33. package/plugins/weppy-roblox-mcp/roblox-plugin/WeppyRobloxMCP.rbxm +0 -0
  34. package/docs/assets/screenshots/roblox-explorer/install-from-vsix.png +0 -0
  35. package/docs/compatibility.md +0 -44
  36. package/docs/en/dashboard/changelog.md +0 -114
  37. package/docs/en/dashboard/connection.md +0 -77
  38. package/docs/en/dashboard/overview.md +0 -95
  39. package/docs/en/dashboard/playtest.md +0 -61
  40. package/docs/en/dashboard/settings.md +0 -60
  41. package/docs/en/dashboard/sync.md +0 -68
  42. package/docs/en/dashboard/tools.md +0 -69
  43. package/docs/en/installation/README.md +0 -95
  44. package/docs/en/installation/ai-apps/antigravity.md +0 -89
  45. package/docs/en/installation/ai-apps/claude-app.md +0 -78
  46. package/docs/en/installation/ai-apps/claude-code.md +0 -104
  47. package/docs/en/installation/ai-apps/codex-app.md +0 -56
  48. package/docs/en/installation/ai-apps/codex-cli.md +0 -67
  49. package/docs/en/installation/ai-apps/cursor.md +0 -77
  50. package/docs/en/installation/ai-apps/gemini-cli.md +0 -120
  51. package/docs/en/installation/roblox-explorer.md +0 -68
  52. package/docs/en/installation/roblox-plugin.md +0 -96
  53. package/docs/en/pro-upgrade.md +0 -96
  54. package/docs/en/sync/luau-lsp.md +0 -41
  55. package/docs/en/sync/overview.md +0 -153
  56. package/docs/en/tools/assets-and-effects.md +0 -104
  57. package/docs/en/tools/instances-and-properties.md +0 -104
  58. package/docs/en/tools/overview.md +0 -277
  59. package/docs/en/tools/playtest.md +0 -140
  60. package/docs/en/tools/scripting.md +0 -66
  61. package/docs/en/tools/system-and-debugging.md +0 -93
  62. package/docs/en/tools/world-and-environment.md +0 -102
  63. package/docs/es/README.md +0 -208
  64. package/docs/es/dashboard/changelog.md +0 -114
  65. package/docs/es/dashboard/connection.md +0 -77
  66. package/docs/es/dashboard/overview.md +0 -95
  67. package/docs/es/dashboard/playtest.md +0 -61
  68. package/docs/es/dashboard/settings.md +0 -60
  69. package/docs/es/dashboard/sync.md +0 -68
  70. package/docs/es/dashboard/tools.md +0 -69
  71. package/docs/es/installation/README.md +0 -87
  72. package/docs/es/installation/ai-apps/antigravity.md +0 -89
  73. package/docs/es/installation/ai-apps/claude-app.md +0 -78
  74. package/docs/es/installation/ai-apps/claude-code.md +0 -104
  75. package/docs/es/installation/ai-apps/codex-app.md +0 -56
  76. package/docs/es/installation/ai-apps/codex-cli.md +0 -67
  77. package/docs/es/installation/ai-apps/cursor.md +0 -77
  78. package/docs/es/installation/ai-apps/gemini-cli.md +0 -120
  79. package/docs/es/installation/roblox-explorer.md +0 -58
  80. package/docs/es/installation/roblox-plugin.md +0 -85
  81. package/docs/es/pro-upgrade.md +0 -96
  82. package/docs/es/sync/luau-lsp.md +0 -41
  83. package/docs/es/sync/overview.md +0 -153
  84. package/docs/es/tools/assets-and-effects.md +0 -104
  85. package/docs/es/tools/instances-and-properties.md +0 -104
  86. package/docs/es/tools/overview.md +0 -277
  87. package/docs/es/tools/playtest.md +0 -140
  88. package/docs/es/tools/scripting.md +0 -66
  89. package/docs/es/tools/system-and-debugging.md +0 -93
  90. package/docs/es/tools/world-and-environment.md +0 -102
  91. package/docs/id/README.md +0 -208
  92. package/docs/id/dashboard/changelog.md +0 -114
  93. package/docs/id/dashboard/connection.md +0 -77
  94. package/docs/id/dashboard/overview.md +0 -95
  95. package/docs/id/dashboard/playtest.md +0 -61
  96. package/docs/id/dashboard/settings.md +0 -60
  97. package/docs/id/dashboard/sync.md +0 -68
  98. package/docs/id/dashboard/tools.md +0 -69
  99. package/docs/id/installation/README.md +0 -93
  100. package/docs/id/installation/ai-apps/antigravity.md +0 -89
  101. package/docs/id/installation/ai-apps/claude-app.md +0 -78
  102. package/docs/id/installation/ai-apps/claude-code.md +0 -104
  103. package/docs/id/installation/ai-apps/codex-app.md +0 -56
  104. package/docs/id/installation/ai-apps/codex-cli.md +0 -67
  105. package/docs/id/installation/ai-apps/cursor.md +0 -77
  106. package/docs/id/installation/ai-apps/gemini-cli.md +0 -120
  107. package/docs/id/installation/roblox-explorer.md +0 -58
  108. package/docs/id/installation/roblox-plugin.md +0 -85
  109. package/docs/id/pro-upgrade.md +0 -96
  110. package/docs/id/sync/luau-lsp.md +0 -41
  111. package/docs/id/sync/overview.md +0 -153
  112. package/docs/id/tools/assets-and-effects.md +0 -104
  113. package/docs/id/tools/instances-and-properties.md +0 -104
  114. package/docs/id/tools/overview.md +0 -277
  115. package/docs/id/tools/playtest.md +0 -140
  116. package/docs/id/tools/scripting.md +0 -66
  117. package/docs/id/tools/system-and-debugging.md +0 -93
  118. package/docs/id/tools/world-and-environment.md +0 -102
  119. package/docs/installer/assets/index-Bz0amd7x.js +0 -63
  120. package/docs/installer/assets/index-ei4lRUa6.css +0 -1
  121. package/docs/installer/index.html +0 -14
  122. package/docs/installer/manifest.webmanifest +0 -15
  123. package/docs/installer/sw.js +0 -7
  124. package/docs/installer/weppy-icon.png +0 -0
  125. package/docs/ja/README.md +0 -206
  126. package/docs/ja/dashboard/changelog.md +0 -114
  127. package/docs/ja/dashboard/connection.md +0 -77
  128. package/docs/ja/dashboard/overview.md +0 -95
  129. package/docs/ja/dashboard/playtest.md +0 -61
  130. package/docs/ja/dashboard/settings.md +0 -60
  131. package/docs/ja/dashboard/sync.md +0 -68
  132. package/docs/ja/dashboard/tools.md +0 -69
  133. package/docs/ja/installation/README.md +0 -93
  134. package/docs/ja/installation/ai-apps/antigravity.md +0 -89
  135. package/docs/ja/installation/ai-apps/claude-app.md +0 -78
  136. package/docs/ja/installation/ai-apps/claude-code.md +0 -104
  137. package/docs/ja/installation/ai-apps/codex-app.md +0 -56
  138. package/docs/ja/installation/ai-apps/codex-cli.md +0 -67
  139. package/docs/ja/installation/ai-apps/cursor.md +0 -77
  140. package/docs/ja/installation/ai-apps/gemini-cli.md +0 -120
  141. package/docs/ja/installation/roblox-explorer.md +0 -58
  142. package/docs/ja/installation/roblox-plugin.md +0 -85
  143. package/docs/ja/pro-upgrade.md +0 -96
  144. package/docs/ja/sync/luau-lsp.md +0 -41
  145. package/docs/ja/sync/overview.md +0 -153
  146. package/docs/ja/tools/assets-and-effects.md +0 -104
  147. package/docs/ja/tools/instances-and-properties.md +0 -104
  148. package/docs/ja/tools/overview.md +0 -277
  149. package/docs/ja/tools/playtest.md +0 -140
  150. package/docs/ja/tools/scripting.md +0 -66
  151. package/docs/ja/tools/system-and-debugging.md +0 -93
  152. package/docs/ja/tools/world-and-environment.md +0 -102
  153. package/docs/ko/README.md +0 -206
  154. package/docs/ko/dashboard/changelog.md +0 -114
  155. package/docs/ko/dashboard/connection.md +0 -77
  156. package/docs/ko/dashboard/overview.md +0 -95
  157. package/docs/ko/dashboard/playtest.md +0 -61
  158. package/docs/ko/dashboard/settings.md +0 -60
  159. package/docs/ko/dashboard/sync.md +0 -68
  160. package/docs/ko/dashboard/tools.md +0 -69
  161. package/docs/ko/installation/README.md +0 -95
  162. package/docs/ko/installation/ai-apps/antigravity.md +0 -88
  163. package/docs/ko/installation/ai-apps/claude-app.md +0 -78
  164. package/docs/ko/installation/ai-apps/claude-code.md +0 -104
  165. package/docs/ko/installation/ai-apps/codex-app.md +0 -56
  166. package/docs/ko/installation/ai-apps/codex-cli.md +0 -67
  167. package/docs/ko/installation/ai-apps/cursor.md +0 -77
  168. package/docs/ko/installation/ai-apps/gemini-cli.md +0 -120
  169. package/docs/ko/installation/roblox-explorer.md +0 -68
  170. package/docs/ko/installation/roblox-plugin.md +0 -96
  171. package/docs/ko/pro-upgrade.md +0 -96
  172. package/docs/ko/sync/luau-lsp.md +0 -41
  173. package/docs/ko/sync/overview.md +0 -153
  174. package/docs/ko/tools/assets-and-effects.md +0 -104
  175. package/docs/ko/tools/instances-and-properties.md +0 -104
  176. package/docs/ko/tools/overview.md +0 -277
  177. package/docs/ko/tools/playtest.md +0 -134
  178. package/docs/ko/tools/scripting.md +0 -66
  179. package/docs/ko/tools/system-and-debugging.md +0 -93
  180. package/docs/ko/tools/world-and-environment.md +0 -102
  181. package/docs/pt-br/README.md +0 -208
  182. package/docs/pt-br/dashboard/changelog.md +0 -114
  183. package/docs/pt-br/dashboard/connection.md +0 -77
  184. package/docs/pt-br/dashboard/overview.md +0 -95
  185. package/docs/pt-br/dashboard/playtest.md +0 -61
  186. package/docs/pt-br/dashboard/settings.md +0 -60
  187. package/docs/pt-br/dashboard/sync.md +0 -68
  188. package/docs/pt-br/dashboard/tools.md +0 -69
  189. package/docs/pt-br/installation/README.md +0 -93
  190. package/docs/pt-br/installation/ai-apps/antigravity.md +0 -89
  191. package/docs/pt-br/installation/ai-apps/claude-app.md +0 -78
  192. package/docs/pt-br/installation/ai-apps/claude-code.md +0 -104
  193. package/docs/pt-br/installation/ai-apps/codex-app.md +0 -56
  194. package/docs/pt-br/installation/ai-apps/codex-cli.md +0 -67
  195. package/docs/pt-br/installation/ai-apps/cursor.md +0 -77
  196. package/docs/pt-br/installation/ai-apps/gemini-cli.md +0 -120
  197. package/docs/pt-br/installation/roblox-explorer.md +0 -58
  198. package/docs/pt-br/installation/roblox-plugin.md +0 -85
  199. package/docs/pt-br/pro-upgrade.md +0 -96
  200. package/docs/pt-br/sync/luau-lsp.md +0 -41
  201. package/docs/pt-br/sync/overview.md +0 -153
  202. package/docs/pt-br/tools/assets-and-effects.md +0 -104
  203. package/docs/pt-br/tools/instances-and-properties.md +0 -104
  204. package/docs/pt-br/tools/overview.md +0 -277
  205. package/docs/pt-br/tools/playtest.md +0 -140
  206. package/docs/pt-br/tools/scripting.md +0 -66
  207. package/docs/pt-br/tools/system-and-debugging.md +0 -93
  208. package/docs/pt-br/tools/world-and-environment.md +0 -102
  209. package/docs/troubleshooting.md +0 -47
  210. package/plugins/weppy-roblox-mcp/dashboard/dist/assets/SettingsPage-D2ZBQ2KF.js +0 -1
  211. package/plugins/weppy-roblox-mcp/dashboard/dist/assets/TierComparison-BwKqP_4s.js +0 -1
  212. package/plugins/weppy-roblox-mcp/dashboard/dist/assets/WhatsNewPage-23o8LmsR.js +0 -1
@@ -1,277 +0,0 @@
1
- # Roblox MCP Tools
2
-
3
- For detailed parameters, check MCP tool definitions directly.
4
-
5
- ## Workflow Guides
6
-
7
- Use these workflow-oriented guides to navigate the toolset:
8
-
9
- | Category | Description | Included tools |
10
- |----------|-------------|----------------|
11
- | [Instances & Properties](instances-and-properties.md) | Instance search, creation, editing, and tags | `query_instances`, `mutate_instances`, `manage_properties` |
12
- | [Scripting & Code Execution](scripting.md) | Script management and Luau execution | `manage_scripts`, `execute_luau` |
13
- | [World & Environment](world-and-environment.md) | Lighting, terrain, spatial queries, and camera | `manage_lighting`, `manage_terrain`, `spatial_query`, `manage_camera` |
14
- | [Assets & Effects](assets-and-effects.md) | Asset insertion, tweening, animation, audio, and effects | `manage_assets`, `manage_tween`, `manage_animation`, `manage_audio`, `manage_effects`, `manage_physics` |
15
- | [Playtest & Automated Tests](playtest.md) | Playtest control and automated validation | `system_info` (`play`, `stop`, `pause`, `resume`, `play_status`, `run_test`) |
16
- | [Sync](../sync/overview.md) | Studio and local file synchronization | `manage_sync`, `workspace_state` |
17
- | [System & Debugging](system-and-debugging.md) | Connection checks, logs, selection, and batch execution | `system_info` (`ping`, `connection`, `usage`, ...), `manage_logs`, `manage_selection`, `batch_execute` |
18
-
19
- Related docs:
20
- - [Sync Deep Dive](../sync/overview.md)
21
-
22
- Sync policy:
23
- - Basic: Studio -> Local one-way sync
24
- - Pro: Bidirectional sync + broader advanced action coverage (better AI token efficiency with bulk workflows)
25
-
26
- ## Query Instances (Mixed)
27
-
28
- | Action | Description | Tier |
29
- |--------|-------------|------|
30
- | `get` | Get instance properties by path | Basic |
31
- | `children` | Get immediate children or all descendants | Basic |
32
- | `find_child` | Find first child by name and optional class filter | Basic |
33
- | `find_descendant` | Find first descendant by name | Basic |
34
- | `wait_for_child` | Wait for child to appear (with timeout) | Basic |
35
- | `class_info` | Get class information and valid properties | Basic |
36
- | `search_name` | Search instances by name pattern (supports wildcards) | Basic |
37
- | `search_class` | Search instances by class name | Basic |
38
- | `file_tree` | Get file tree structure from root | Pro |
39
- | `project_structure` | Get complete project structure | Pro |
40
- | `descendants` | Get all descendants of an instance | Pro |
41
- | `ancestors` | Get all ancestors of an instance | Pro |
42
- | `search_property` | Search instances by property value | Pro |
43
- | `search_tag` | Search instances by tag | Pro |
44
-
45
- ## Mutate Instances (Mixed)
46
-
47
- | Action | Description | Tier |
48
- |--------|-------------|------|
49
- | `create` | Create a new instance | Basic |
50
- | `create_with_props` | Create instance with initial properties | Basic |
51
- | `delete` | Delete an instance | Basic |
52
- | `clone` | Clone an instance | Basic |
53
- | `move` | Move instance to new parent | Basic |
54
- | `rename` | Rename an instance | Basic |
55
- | `pivot` | Set pivot position or CFrame | Basic |
56
- | `create_tree` | Create hierarchical instance tree | Pro |
57
- | `mass_create` | Create multiple instances at once | Pro |
58
- | `mass_delete` | Delete multiple instances | Pro |
59
- | `mass_duplicate` | Duplicate multiple instances | Pro |
60
- | `smart_duplicate` | Duplicate with spacing and count | Pro |
61
-
62
- ## Manage Properties (Mixed)
63
-
64
- | Action | Description | Tier |
65
- |--------|-------------|------|
66
- | `get` | Get a single property value | Basic |
67
- | `set` | Set a single property value | Basic |
68
- | `get_all` | Get all properties of an instance | Basic |
69
- | `set_multiple` | Set multiple properties at once | Basic |
70
- | `get_attr` | Get attribute value | Basic |
71
- | `set_attr` | Set attribute value | Basic |
72
- | `get_all_attrs` | Get all attributes | Basic |
73
- | `delete_attr` | Delete an attribute | Basic |
74
- | `add_tag` | Add a tag to instance | Basic |
75
- | `remove_tag` | Remove a tag from instance | Basic |
76
- | `check_tag` | Check if instance has a tag | Basic |
77
- | `get_tags` | Get all tags on an instance | Basic |
78
- | `get_tagged` | Get all instances with a specific tag | Basic |
79
- | `set_calculated` | Set property using mathematical expression | Pro |
80
- | `set_relative` | Set property relative to current value | Pro |
81
- | `mass_set` | Set property on multiple instances | Pro |
82
- | `mass_get` | Get property from multiple instances | Pro |
83
- | `modify_children` | Modify all children of a parent | Pro |
84
-
85
- ## Manage Scripts (Mixed)
86
-
87
- | Action | Description | Tier |
88
- |--------|-------------|------|
89
- | `get_source` | Get script source code | Basic |
90
- | `set_source` | Set script source code | Basic |
91
- | `create` | Create a new script | Basic |
92
- | `delete` | Delete a script | Basic |
93
- | `edit_replace` | Replace specific lines in script | Basic |
94
- | `edit_insert` | Insert lines at position | Basic |
95
- | `edit_delete` | Delete specific lines | Basic |
96
- | `search` | Search for text in script | Basic |
97
- | `get_dependencies` | Get script dependencies | Basic |
98
- | `replace` | Batch replace across scripts | Pro |
99
-
100
- ## Manage Lighting (Pro)
101
-
102
- | Action | Description | Tier |
103
- |--------|-------------|------|
104
- | `lighting` | Set Lighting service properties | Pro |
105
- | `atmosphere` | Set Atmosphere properties | Pro |
106
- | `sky` | Set Sky properties | Pro |
107
- | `terrain_props` | Set Terrain water/visual properties | Pro |
108
- | `time` | Set time of day | Pro |
109
-
110
- ## Manage Selection (Mixed)
111
-
112
- | Action | Description | Tier |
113
- |--------|-------------|------|
114
- | `get` | Get current selection | Basic |
115
- | `set` | Replace current selection | Basic |
116
- | `clear` | Clear selection | Basic |
117
- | `cached` | Get cached selection without round-trip | Basic |
118
- | `context` | Get detailed context with source and properties | Pro |
119
- | `details` | Get hierarchical details with ancestors/descendants | Pro |
120
- | `add` | Add items to selection | Pro |
121
- | `remove` | Remove items from selection | Pro |
122
- | `watch` | Monitor selection changes | Pro |
123
-
124
- ## Manage Camera (Basic)
125
-
126
- | Action | Description | Tier |
127
- |--------|-------------|------|
128
- | `info` | Get camera position, rotation, FOV, viewport size | Basic |
129
- | `focus_path` | Move camera to focus on instance | Basic |
130
- | `focus_position` | Move camera to focus on position | Basic |
131
- | `suggest` | Get suggested camera view for target | Basic |
132
-
133
- ## Manage Tween (Pro)
134
-
135
- | Action | Description | Tier |
136
- |--------|-------------|------|
137
- | `create` | Create a tween with target properties | Pro |
138
- | `play` | Play a created tween | Pro |
139
- | `pause` | Pause a running tween | Pro |
140
- | `cancel` | Cancel a tween | Pro |
141
-
142
- ## Manage Audio (Pro)
143
-
144
- | Action | Description | Tier |
145
- |--------|-------------|------|
146
- | `play` | Play a sound (creates Sound if needed) | Pro |
147
- | `stop` | Stop a playing sound | Pro |
148
- | `pause` | Pause a playing sound | Pro |
149
- | `resume` | Resume a paused sound | Pro |
150
- | `set_listener` | Set audio listener type/target | Pro |
151
-
152
- ## Manage Animation (Pro)
153
-
154
- | Action | Description | Tier |
155
- |--------|-------------|------|
156
- | `load` | Load animation on Humanoid/AnimationController | Pro |
157
- | `play` | Play a loaded animation track | Pro |
158
- | `stop` | Stop a playing animation | Pro |
159
- | `get_tracks` | List all loaded animation tracks | Pro |
160
-
161
- ## Manage Physics (Pro)
162
-
163
- | Action | Description | Tier |
164
- |--------|-------------|------|
165
- | `register_group` | Register a collision group | Pro |
166
- | `set_collidable` | Set whether two groups can collide | Pro |
167
- | `get_groups` | List all registered collision groups | Pro |
168
-
169
- ## Manage Effects (Pro)
170
-
171
- | Action | Description | Tier |
172
- |--------|-------------|------|
173
- | `emit` | Emit particles from ParticleEmitter | Pro |
174
- | `clear` | Clear all particles | Pro |
175
- | `toggle` | Enable or disable effect | Pro |
176
-
177
- ## Manage Terrain (Pro)
178
-
179
- | Action | Description | Tier |
180
- |--------|-------------|------|
181
- | `fill_block` | Fill block-shaped terrain | Pro |
182
- | `fill_ball` | Fill sphere-shaped terrain | Pro |
183
- | `fill_cylinder` | Fill cylinder-shaped terrain | Pro |
184
- | `fill_wedge` | Fill wedge-shaped terrain | Pro |
185
- | `clear_region` | Clear terrain in region | Pro |
186
- | `clear_bounds` | Clear terrain in bounds | Pro |
187
- | `replace_material` | Replace material in region | Pro |
188
- | `colors_get` | Get material colors | Pro |
189
- | `colors_set` | Set material colors | Pro |
190
- | `read_voxel` | Read single voxel data | Pro |
191
- | `read_voxels` | Read bulk voxel data | Pro |
192
- | `write_voxels` | Write bulk voxel data | Pro |
193
- | `generate` | Generate procedural terrain | Pro |
194
- | `smooth` | Smooth terrain | Pro |
195
-
196
- ## Spatial Query (Pro)
197
-
198
- | Action | Description | Tier |
199
- |--------|-------------|------|
200
- | `raycast` | Cast a single ray | Pro |
201
- | `find_ground` | Find ground position below point | Pro |
202
- | `check_placement` | Check if placement is collision-free | Pro |
203
- | `multi_raycast` | Cast multiple rays in batch | Pro |
204
- | `scan_area` | Generate heightmap of area | Pro |
205
- | `find_flat` | Find flat areas for building | Pro |
206
- | `find_spawn` | Find suitable spawn positions | Pro |
207
- | `analyze_walkable` | Analyze walkability grid | Pro |
208
- | `spatial_map` | Get all BasePart positions | Pro |
209
- | `find_space` | Find empty space for object | Pro |
210
- | `bounds` | Get bounding box of instances | Pro |
211
- | `snap_grid` | Snap position to grid | Pro |
212
- | `collision` | Check AABB collision | Pro |
213
-
214
- ## Manage Assets (Pro)
215
-
216
- | Action | Description | Tier |
217
- |--------|-------------|------|
218
- | `insert` | Insert model by asset ID | Pro |
219
- | `info` | Get asset metadata | Pro |
220
- | `search` | Search Creator Store | Pro |
221
- | `search_insert` | Search and insert first match | Pro |
222
- | `insert_free` | Insert free model | Pro |
223
- | `insert_package` | Insert package | Pro |
224
- | `export` | Export current selection | Pro |
225
-
226
- ## Manage Sync (Pro)
227
-
228
- | Action | Description | Tier |
229
- |--------|-------------|------|
230
- | `status_current_place` | Get sync status for the current connected place | Pro |
231
- | `history` | Get change history | Pro |
232
- | `directions` | Get per-type sync directions | Pro |
233
- | `read_file` | Read a synced file | Pro |
234
- | `write_file` | Write to a synced file | Pro |
235
- | `progress` | Get real-time sync progress and bandwidth | Pro |
236
-
237
- ## Workspace State (Pro)
238
-
239
- | Action | Description | Tier |
240
- |--------|-------------|------|
241
- | `sync` | Fetch current Workspace state | Pro |
242
- | `snapshot` | Get full instance tree structure | Pro |
243
- | `changes` | Get recent changes | Pro |
244
- | `viewport` | Get camera and viewport info | Pro |
245
-
246
- ## Manage Logs (Basic)
247
-
248
- | Action | Description | Tier |
249
- |--------|-------------|------|
250
- | `get` | Get filtered logs | Basic |
251
- | `clear` | Clear log buffer | Basic |
252
- | `errors` | Get recent errors only | Basic |
253
-
254
- ## System Info (Mixed)
255
-
256
- | Action | Description | Tier |
257
- |--------|-------------|------|
258
- | `ping` | Test connection | Basic |
259
- | `connection` | Get server/plugin connection info | Basic |
260
- | `usage` | Get current tier (basic/pro) | Basic |
261
- | `place_info` | Get place ID, name, creator | Pro |
262
- | `services` | List all Roblox services | Pro |
263
- | `studio_settings` | Get Studio preferences | Pro |
264
- | `play` | Start playtest in Play (F5) or Run (F8) mode | Pro |
265
- | `stop` | Stop the active playtest | Pro |
266
- | `pause` | Pause the active Run-mode playtest | Pro |
267
- | `resume` | Resume the paused Run-mode playtest | Pro |
268
- | `play_status` | Get playtest state and available actions | Pro |
269
- | `run_test` | Inject a temporary test script, run playtest, collect logs, and write local report files | Pro |
270
-
271
- ## Batch Execute (Pro)
272
-
273
- Execute multiple commands in a single batch. Each command specifies a tool name and arguments. Commands execute sequentially with optional continue-on-error behavior.
274
-
275
- ## Execute Luau (Pro)
276
-
277
- Execute arbitrary Luau code in Roblox Studio sandbox. Blocked services: HttpService, DataStoreService, MessagingService. Cannot access CoreGui/CorePackages.
@@ -1,140 +0,0 @@
1
- # Playtest & Automated Tests
2
-
3
- > Control Roblox Studio playtests with AI, inject test scripts, and automatically generate logs and local reports.
4
-
5
- ## Included Tools
6
-
7
- | Tool | Tier | Description |
8
- |------|:----:|-------------|
9
- | `system_info` | Pro | `play`, `stop`, `pause`, `resume`, `play_status`, `run_test` actions |
10
-
11
- > For the other `system_info` actions such as `ping`, `connection`, and `usage`, see [System & Debugging](system-and-debugging.md).
12
-
13
- ## Key Workflows
14
-
15
- ### Manual playtest control
16
-
17
- ```
18
- "Start the game in Play mode (F5)."
19
- "Stop the current playtest."
20
- ```
21
-
22
- Typical flow: `play` -> `play_status` -> `stop`.
23
-
24
- ### Run an automated test
25
-
26
- ```
27
- "Write and run a test that checks whether the SpawnLocation is positioned correctly."
28
- ```
29
-
30
- `run_test` injects the test script, starts the playtest automatically, collects logs, and cleans up.
31
-
32
- ### CI-style verification
33
-
34
- ```
35
- "Run a Run-mode (F8) test that verifies the NPC reaches the target, and show me the logs if it fails."
36
- ```
37
-
38
- Use `run_test` with `mode: "run"` for server-focused validation.
39
-
40
- ## Playtest State Machine
41
-
42
- ```text
43
- Edit --play--> Running --stop--> Edit
44
- | ^
45
- pause |
46
- | |
47
- v |
48
- Paused --resume--> Running
49
- ```
50
-
51
- | State | Available actions |
52
- |-------|-------------------|
53
- | `edit` | `play` |
54
- | `running` | `stop`, `pause` (Run mode only) |
55
- | `paused` | `resume`, `stop` |
56
-
57
- - Play mode (F5): client + server simulation, no pause or resume
58
- - Run mode (F8): server-only simulation, supports pause and resume
59
-
60
- ## `run_test` Pipeline
61
-
62
- `run_test` orchestrates these steps automatically:
63
-
64
- ### 1. Prepare
65
-
66
- - Read place information with `place_info`
67
- - Clear the existing log buffer
68
-
69
- ### 2. Inject the script
70
-
71
- - Create `ServerScriptService.__MCP_TestRunner` with a wrapped test script
72
- - The wrapper handles `START` and `FINISHED` signals plus error tracebacks
73
-
74
- ### 3. Execute and monitor
75
-
76
- - Start the playtest in Play or Run mode
77
- - Poll logs every 500 ms
78
- - Finish when `[WEPPY_TEST]:FINISHED` is detected
79
- - Stop automatically on timeout (default 60 seconds, maximum 300)
80
-
81
- ### 4. Clean up
82
-
83
- - Stop the playtest automatically
84
- - Delete the injected test script
85
- - Collect final logs
86
-
87
- ### 5. Write reports
88
-
89
- Reports and logs are written under `{projectRoot}/weppy-project-sync/place_XXXXX/tests/YYYYMMDD-HHmmss/`.
90
-
91
- ```text
92
- {projectRoot}/weppy-project-sync/place_XXXXX/tests/YYYYMMDD-HHmmss/
93
- ├── test-report.md
94
- └── test-log.txt
95
- ```
96
-
97
- Example `test-report.md`:
98
-
99
- ```markdown
100
- # Test Report
101
-
102
- - Status: passed
103
- - Test Name: spawn_location_test
104
- - Mode: run
105
- - Place ID: 123456
106
- - Duration (ms): 1523
107
- - Total Logs: 12
108
- - Signal Count: 2
109
-
110
- ## Signals
111
-
112
- - START: 2026-03-12T10:30:00.000Z
113
- - FINISHED: 2026-03-12T10:30:01.523Z
114
- ```
115
-
116
- ## Action Reference
117
-
118
- | Action | Description | Parameters | Tier |
119
- |--------|-------------|------------|------|
120
- | `play` | Start a playtest in Play (F5) or Run (F8) mode | `mode`: `"play"` \| `"run"` | Pro |
121
- | `stop` | Stop the current playtest | - | Pro |
122
- | `pause` | Pause a Run-mode playtest | - | Pro |
123
- | `resume` | Resume a paused Run-mode playtest | - | Pro |
124
- | `play_status` | Get playtest state and available actions | - | Pro |
125
- | `run_test` | Inject a test script, run playtest, collect logs, and write reports | `script` (required), `test_name`, `mode`, `timeout` | Pro |
126
-
127
- ### `run_test` Parameters
128
-
129
- | Parameter | Type | Required | Description |
130
- |-----------|------|:--------:|-------------|
131
- | `script` | string | ✅ | Luau test code body to execute |
132
- | `test_name` | string | - | Display name used in the report |
133
- | `mode` | `"play"` \| `"run"` | - | Playtest mode, defaults to `"play"` |
134
- | `timeout` | number | - | Timeout in seconds, default 60, maximum 300 |
135
-
136
- ## Related Docs
137
-
138
- - [System & Debugging](system-and-debugging.md) - connection actions and log management
139
- - [Scripting & Code Execution](scripting.md) - write scripts and run Luau
140
- - [Tools Reference](overview.md)
@@ -1,66 +0,0 @@
1
- # Scripting & Code Execution
2
-
3
- > Manage script source code and run arbitrary Luau inside Roblox Studio.
4
-
5
- ## Included Tools
6
-
7
- | Tool | Tier | Description |
8
- |------|:----:|-------------|
9
- | `manage_scripts` | Mixed | Create, read, edit, search, and analyze script dependencies |
10
- | `execute_luau` | Pro | Run arbitrary Luau in the Roblox Studio sandbox |
11
-
12
- ## Key Workflows
13
-
14
- ### Edit a script
15
-
16
- ```
17
- "Change maxPlayers from 12 to 24 in the GameManager script under ServerScriptService."
18
- ```
19
-
20
- Use `manage_scripts.search` to find the relevant line, then `manage_scripts.edit_replace` to update it.
21
-
22
- ### Refactor multiple scripts (Pro)
23
-
24
- ```
25
- "Replace OldModule with NewModule across every script."
26
- ```
27
-
28
- Use `manage_scripts.replace` to apply the change across multiple scripts in one request.
29
-
30
- ### Inspect runtime data (Pro)
31
-
32
- ```
33
- "Calculate the average Health of every Humanoid currently in Workspace."
34
- ```
35
-
36
- Use `execute_luau` to run custom Luau and read live runtime data.
37
-
38
- ## Action Reference
39
-
40
- ### Manage Scripts (Mixed)
41
-
42
- | Action | Description | Tier |
43
- |--------|-------------|------|
44
- | `get_source` | Get script source code | Basic |
45
- | `set_source` | Set script source code | Basic |
46
- | `create` | Create a new script | Basic |
47
- | `delete` | Delete a script | Basic |
48
- | `edit_replace` | Replace specific lines in a script | Basic |
49
- | `edit_insert` | Insert lines at a position | Basic |
50
- | `edit_delete` | Delete specific lines | Basic |
51
- | `search` | Search for text in scripts | Basic |
52
- | `get_dependencies` | Get script dependencies | Basic |
53
- | `replace` | Batch replace across scripts | Pro |
54
-
55
- ### Execute Luau (Pro)
56
-
57
- Run arbitrary Luau inside the Roblox Studio sandbox.
58
-
59
- - Blocked services: `HttpService`, `DataStoreService`, `MessagingService`
60
- - Inaccessible APIs: `CoreGui`, `CorePackages`
61
-
62
- ## Related Docs
63
-
64
- - [Instances & Properties](instances-and-properties.md) - create or move script instances
65
- - [Playtest & Automated Tests](playtest.md) - inject and run test scripts
66
- - [Tools Reference](overview.md)
@@ -1,93 +0,0 @@
1
- # System & Debugging
2
-
3
- > Check connection state, manage logs, control Studio selection, and batch commands for debugging workflows.
4
-
5
- ## Included Tools
6
-
7
- | Tool | Tier | Description |
8
- |------|:----:|-------------|
9
- | `system_info` | Mixed | `ping`, `connection`, `usage`, `place_info`, `services`, `studio_settings` |
10
- | `manage_logs` | Basic | Query logs, clear buffers, and filter recent errors |
11
- | `manage_selection` | Mixed | Read, replace, and monitor Studio selection |
12
- | `batch_execute` | Pro | Execute multiple commands in one batch |
13
-
14
- > For the playtest actions on `system_info` such as `play`, `stop`, and `run_test`, see [Playtest & Automated Tests](playtest.md).
15
-
16
- ## Key Workflows
17
-
18
- ### Check the connection
19
-
20
- ```
21
- "Check whether Studio is connected correctly."
22
- ```
23
-
24
- Use `system_info.ping` for a quick health check.
25
-
26
- ### Debug recent errors
27
-
28
- ```
29
- "Show me the most recent error logs."
30
- ```
31
-
32
- Use `manage_logs.errors` to filter only recent errors. `manage_logs.get` also supports incremental polling with a `sinceSeq` cursor.
33
-
34
- ### Run a batch workflow (Pro)
35
-
36
- ```
37
- "Turn every Part in Workspace red, then focus the camera on the first one."
38
- ```
39
-
40
- Use `batch_execute` to bundle multiple commands into one request.
41
-
42
- ## Action Reference
43
-
44
- ### System Info (Mixed)
45
-
46
- | Action | Description | Tier |
47
- |--------|-------------|------|
48
- | `ping` | Test the connection | Basic |
49
- | `connection` | Get server and plugin connection info | Basic |
50
- | `usage` | Get the current tier (`basic` or `pro`) | Basic |
51
- | `place_info` | Get place ID, name, and creator | Pro |
52
- | `services` | List all Roblox services | Pro |
53
- | `studio_settings` | Get Studio preferences | Pro |
54
-
55
- ### Manage Logs (Basic)
56
-
57
- | Action | Description | Tier |
58
- |--------|-------------|------|
59
- | `get` | Get filtered logs with optional `sinceSeq` cursor support | Basic |
60
- | `clear` | Clear the log buffer | Basic |
61
- | `errors` | Get recent errors only | Basic |
62
-
63
- ### Manage Selection (Mixed)
64
-
65
- | Action | Description | Tier |
66
- |--------|-------------|------|
67
- | `get` | Get the current selection | Basic |
68
- | `set` | Replace the current selection | Basic |
69
- | `clear` | Clear the selection | Basic |
70
- | `cached` | Get cached selection without a round trip | Basic |
71
- | `context` | Get detailed context with source and properties | Pro |
72
- | `details` | Get hierarchical details with ancestors and descendants | Pro |
73
- | `add` | Add items to the selection | Pro |
74
- | `remove` | Remove items from the selection | Pro |
75
- | `watch` | Monitor selection changes | Pro |
76
-
77
- ### Manage Context (Basic)
78
-
79
- | Action | Description | Tier |
80
- |--------|-------------|------|
81
- | `begin` | Start a structured execution context for the current session/place scope | Basic |
82
- | `update` | Update intent, affected areas, or replay metadata for the active context | Basic |
83
- | `end` | Close the active execution context and persist the final snapshot | Basic |
84
-
85
- ### Batch Execute (Pro)
86
-
87
- Execute multiple commands in one batch. Each command includes a tool name and arguments, runs sequentially, and can optionally continue after errors.
88
-
89
- ## Related Docs
90
-
91
- - [Playtest & Automated Tests](playtest.md) - playtest control on `system_info`
92
- - [Scripting & Code Execution](scripting.md) - run Luau for investigation or debugging
93
- - [Tools Reference](overview.md)
@@ -1,102 +0,0 @@
1
- # World & Environment
2
-
3
- > Build and inspect the game world with lighting, terrain, spatial queries, and camera tools.
4
-
5
- ## Included Tools
6
-
7
- | Tool | Tier | Description |
8
- |------|:----:|-------------|
9
- | `manage_lighting` | Pro | Configure Lighting, Atmosphere, Sky, and time of day |
10
- | `manage_terrain` | Pro | Generate and edit terrain, including voxel data |
11
- | `spatial_query` | Pro | Raycasts, ground checks, placement validation, and heightmaps |
12
- | `manage_camera` | Basic | Inspect camera state, move focus, and get suggested views |
13
-
14
- ## Key Workflows
15
-
16
- ### Set the mood (Pro)
17
-
18
- ```
19
- "Switch the map to a sunset mood with orange skies, heavier fog, and 18:00 time."
20
- ```
21
-
22
- Use `manage_lighting.time` for the clock, `manage_lighting.atmosphere` for fog, and `manage_lighting.sky` for sky visuals.
23
-
24
- ### Shape terrain (Pro)
25
-
26
- ```
27
- "Create a grassy hill with radius 200 at the center of the map and surround it with water."
28
- ```
29
-
30
- Use `manage_terrain.fill_ball` for the hill, then `manage_terrain.fill_block` to place surrounding water.
31
-
32
- ### Validate placement (Pro)
33
-
34
- ```
35
- "Find a flat area where I can place this building."
36
- ```
37
-
38
- Use `spatial_query.find_flat` to find candidates, `spatial_query.check_placement` to validate them, and `manage_camera.focus_position` to inspect the result visually.
39
-
40
- ## Action Reference
41
-
42
- ### Manage Lighting (Pro)
43
-
44
- | Action | Description | Tier |
45
- |--------|-------------|------|
46
- | `lighting` | Set Lighting service properties | Pro |
47
- | `atmosphere` | Set Atmosphere properties | Pro |
48
- | `sky` | Set Sky properties | Pro |
49
- | `terrain_props` | Set Terrain water and visual properties | Pro |
50
- | `time` | Set time of day | Pro |
51
-
52
- ### Manage Terrain (Pro)
53
-
54
- | Action | Description | Tier |
55
- |--------|-------------|------|
56
- | `fill_block` | Fill block-shaped terrain | Pro |
57
- | `fill_ball` | Fill sphere-shaped terrain | Pro |
58
- | `fill_cylinder` | Fill cylinder-shaped terrain | Pro |
59
- | `fill_wedge` | Fill wedge-shaped terrain | Pro |
60
- | `clear_region` | Clear terrain in a region | Pro |
61
- | `clear_bounds` | Clear terrain in bounds | Pro |
62
- | `replace_material` | Replace material in a region | Pro |
63
- | `colors_get` | Get material colors | Pro |
64
- | `colors_set` | Set material colors | Pro |
65
- | `read_voxel` | Read a single voxel | Pro |
66
- | `read_voxels` | Read bulk voxel data | Pro |
67
- | `write_voxels` | Write bulk voxel data | Pro |
68
- | `generate` | Generate procedural terrain | Pro |
69
- | `smooth` | Smooth terrain | Pro |
70
-
71
- ### Spatial Query (Pro)
72
-
73
- | Action | Description | Tier |
74
- |--------|-------------|------|
75
- | `raycast` | Cast a single ray | Pro |
76
- | `find_ground` | Find the ground position below a point | Pro |
77
- | `check_placement` | Check whether a placement is collision-free | Pro |
78
- | `multi_raycast` | Cast multiple rays in batch | Pro |
79
- | `scan_area` | Generate a heightmap of an area | Pro |
80
- | `find_flat` | Find flat areas for building | Pro |
81
- | `find_spawn` | Find suitable spawn positions | Pro |
82
- | `analyze_walkable` | Analyze a walkability grid | Pro |
83
- | `spatial_map` | Get all BasePart positions | Pro |
84
- | `find_space` | Find empty space for an object | Pro |
85
- | `bounds` | Get instance bounding boxes | Pro |
86
- | `snap_grid` | Snap a position to the grid | Pro |
87
- | `collision` | Check AABB collision | Pro |
88
-
89
- ### Manage Camera (Basic)
90
-
91
- | Action | Description | Tier |
92
- |--------|-------------|------|
93
- | `info` | Get camera position, rotation, FOV, and viewport size | Basic |
94
- | `focus_path` | Move the camera to focus on an instance | Basic |
95
- | `focus_position` | Move the camera to focus on a position | Basic |
96
- | `suggest` | Get a suggested camera view for a target | Basic |
97
-
98
- ## Related Docs
99
-
100
- - [Instances & Properties](instances-and-properties.md) - place world objects
101
- - [Assets & Effects](assets-and-effects.md) - add effects, audio, and animation
102
- - [Tools Reference](overview.md)