@weppy/roblox-mcp 1.2.3 → 1.3.1
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.
- package/.claude-plugin/marketplace.json +2 -2
- package/.github/ISSUE_TEMPLATE/bug_report.yml +60 -0
- package/.github/ISSUE_TEMPLATE/feature_request.yml +30 -0
- package/.github/ISSUE_TEMPLATE/install_help.yml +48 -0
- package/.github/PULL_REQUEST_TEMPLATE.md +16 -0
- package/.github/workflows/deploy-docs.yml +41 -0
- package/CHANGELOG.md +48 -0
- package/CODE_OF_CONDUCT.md +29 -0
- package/CONTRIBUTING.md +36 -0
- package/README.md +41 -23
- package/SECURITY.md +28 -0
- package/SUPPORT.md +26 -0
- package/docs/compatibility.md +44 -0
- package/docs/en/sync/overview.md +24 -0
- package/docs/es/README.md +39 -21
- package/docs/es/sync/overview.md +24 -0
- package/docs/id/README.md +39 -21
- package/docs/id/sync/overview.md +24 -0
- package/docs/ja/README.md +41 -23
- package/docs/ja/sync/overview.md +24 -0
- package/docs/ko/README.md +39 -21
- package/docs/ko/sync/overview.md +24 -0
- package/docs/pt-br/README.md +39 -21
- package/docs/pt-br/sync/overview.md +24 -0
- package/docs/troubleshooting.md +47 -0
- package/llms.txt +45 -0
- package/package.json +1 -1
- package/plugins/weppy-roblox-mcp/.claude-plugin/plugin.json +1 -1
- package/plugins/weppy-roblox-mcp/dist/index.js +48 -48
|
@@ -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.
|
|
9
|
+
"version": "1.3.1"
|
|
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 - AI-powered game development with specialized agents and skills",
|
|
16
|
-
"version": "1.
|
|
16
|
+
"version": "1.3.1",
|
|
17
17
|
"author": {
|
|
18
18
|
"name": "hope1026"
|
|
19
19
|
},
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
name: Bug Report
|
|
2
|
+
description: Something isn't working correctly
|
|
3
|
+
labels: ["bug"]
|
|
4
|
+
body:
|
|
5
|
+
- type: markdown
|
|
6
|
+
attributes:
|
|
7
|
+
value: |
|
|
8
|
+
Before reporting, check [Troubleshooting](https://github.com/hope1026/roblox-mcp/blob/main/docs/en/troubleshooting.md)
|
|
9
|
+
and [Discussions](https://github.com/hope1026/roblox-mcp/discussions).
|
|
10
|
+
- type: input
|
|
11
|
+
id: os
|
|
12
|
+
attributes:
|
|
13
|
+
label: OS
|
|
14
|
+
placeholder: "macOS 14 / Windows 11"
|
|
15
|
+
validations:
|
|
16
|
+
required: true
|
|
17
|
+
- type: input
|
|
18
|
+
id: node
|
|
19
|
+
attributes:
|
|
20
|
+
label: Node.js version
|
|
21
|
+
placeholder: "node --version output"
|
|
22
|
+
validations:
|
|
23
|
+
required: true
|
|
24
|
+
- type: input
|
|
25
|
+
id: ai-client
|
|
26
|
+
attributes:
|
|
27
|
+
label: AI client
|
|
28
|
+
placeholder: "Claude Code 1.x / Cursor 0.4x / Codex CLI"
|
|
29
|
+
validations:
|
|
30
|
+
required: true
|
|
31
|
+
- type: input
|
|
32
|
+
id: plugin-version
|
|
33
|
+
attributes:
|
|
34
|
+
label: Plugin / MCP server version
|
|
35
|
+
placeholder: "v1.3.1"
|
|
36
|
+
validations:
|
|
37
|
+
required: true
|
|
38
|
+
- type: textarea
|
|
39
|
+
id: steps
|
|
40
|
+
attributes:
|
|
41
|
+
label: Steps to reproduce
|
|
42
|
+
validations:
|
|
43
|
+
required: true
|
|
44
|
+
- type: textarea
|
|
45
|
+
id: expected
|
|
46
|
+
attributes:
|
|
47
|
+
label: Expected behavior
|
|
48
|
+
validations:
|
|
49
|
+
required: true
|
|
50
|
+
- type: textarea
|
|
51
|
+
id: actual
|
|
52
|
+
attributes:
|
|
53
|
+
label: Actual behavior
|
|
54
|
+
validations:
|
|
55
|
+
required: true
|
|
56
|
+
- type: textarea
|
|
57
|
+
id: logs
|
|
58
|
+
attributes:
|
|
59
|
+
label: Logs (if any)
|
|
60
|
+
render: shell
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
name: Feature Request
|
|
2
|
+
description: Suggest a new feature or improvement
|
|
3
|
+
labels: ["enhancement"]
|
|
4
|
+
body:
|
|
5
|
+
- type: textarea
|
|
6
|
+
id: problem
|
|
7
|
+
attributes:
|
|
8
|
+
label: What problem does this solve?
|
|
9
|
+
placeholder: "e.g. I can't easily do X with the current tools"
|
|
10
|
+
validations:
|
|
11
|
+
required: true
|
|
12
|
+
- type: textarea
|
|
13
|
+
id: solution
|
|
14
|
+
attributes:
|
|
15
|
+
label: Proposed solution
|
|
16
|
+
validations:
|
|
17
|
+
required: true
|
|
18
|
+
- type: dropdown
|
|
19
|
+
id: tier
|
|
20
|
+
attributes:
|
|
21
|
+
label: Which tier would this apply to?
|
|
22
|
+
options:
|
|
23
|
+
- Basic
|
|
24
|
+
- Pro
|
|
25
|
+
- Both
|
|
26
|
+
- Not sure
|
|
27
|
+
- type: textarea
|
|
28
|
+
id: context
|
|
29
|
+
attributes:
|
|
30
|
+
label: Additional context
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
name: Install Help
|
|
2
|
+
description: Having trouble installing or connecting
|
|
3
|
+
labels: ["question", "installation"]
|
|
4
|
+
body:
|
|
5
|
+
- type: markdown
|
|
6
|
+
attributes:
|
|
7
|
+
value: |
|
|
8
|
+
**First:** check the [Installation Guide](https://github.com/hope1026/roblox-mcp/blob/main/docs/en/installation/README.md)
|
|
9
|
+
and [Troubleshooting](https://github.com/hope1026/roblox-mcp/blob/main/docs/en/troubleshooting.md).
|
|
10
|
+
For general questions, use [Discussions](https://github.com/hope1026/roblox-mcp/discussions) instead.
|
|
11
|
+
- type: dropdown
|
|
12
|
+
id: ai-client
|
|
13
|
+
attributes:
|
|
14
|
+
label: AI client
|
|
15
|
+
options:
|
|
16
|
+
- Claude Code
|
|
17
|
+
- Claude Desktop
|
|
18
|
+
- Cursor
|
|
19
|
+
- Codex CLI
|
|
20
|
+
- Gemini CLI
|
|
21
|
+
- Other
|
|
22
|
+
validations:
|
|
23
|
+
required: true
|
|
24
|
+
- type: input
|
|
25
|
+
id: os
|
|
26
|
+
attributes:
|
|
27
|
+
label: OS
|
|
28
|
+
placeholder: "macOS 14 / Windows 11"
|
|
29
|
+
validations:
|
|
30
|
+
required: true
|
|
31
|
+
- type: input
|
|
32
|
+
id: node
|
|
33
|
+
attributes:
|
|
34
|
+
label: Node.js version
|
|
35
|
+
placeholder: "node --version output"
|
|
36
|
+
validations:
|
|
37
|
+
required: true
|
|
38
|
+
- type: textarea
|
|
39
|
+
id: issue
|
|
40
|
+
attributes:
|
|
41
|
+
label: What's happening?
|
|
42
|
+
placeholder: "Describe the problem and any error messages"
|
|
43
|
+
validations:
|
|
44
|
+
required: true
|
|
45
|
+
- type: textarea
|
|
46
|
+
id: tried
|
|
47
|
+
attributes:
|
|
48
|
+
label: What have you tried?
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
## What does this PR do?
|
|
2
|
+
|
|
3
|
+
<!-- Brief description of the change -->
|
|
4
|
+
|
|
5
|
+
## Type of change
|
|
6
|
+
|
|
7
|
+
- [ ] Documentation improvement
|
|
8
|
+
- [ ] Example prompt or cookbook addition
|
|
9
|
+
- [ ] Bug fix
|
|
10
|
+
- [ ] Other
|
|
11
|
+
|
|
12
|
+
## Checklist
|
|
13
|
+
|
|
14
|
+
- [ ] I've read [CONTRIBUTING.md](../CONTRIBUTING.md)
|
|
15
|
+
- [ ] Changes are limited to docs or examples (plugin source is not in this repo)
|
|
16
|
+
- [ ] Links and paths are correct
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
name: Deploy docs to GitHub Pages
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
branches: [main]
|
|
6
|
+
paths:
|
|
7
|
+
- 'docs/**'
|
|
8
|
+
- 'README.md'
|
|
9
|
+
- 'llms.txt'
|
|
10
|
+
workflow_dispatch:
|
|
11
|
+
|
|
12
|
+
permissions:
|
|
13
|
+
contents: read
|
|
14
|
+
pages: write
|
|
15
|
+
id-token: write
|
|
16
|
+
|
|
17
|
+
concurrency:
|
|
18
|
+
group: pages
|
|
19
|
+
cancel-in-progress: false
|
|
20
|
+
|
|
21
|
+
jobs:
|
|
22
|
+
deploy:
|
|
23
|
+
environment:
|
|
24
|
+
name: github-pages
|
|
25
|
+
url: ${{ steps.deployment.outputs.page_url }}
|
|
26
|
+
runs-on: ubuntu-latest
|
|
27
|
+
steps:
|
|
28
|
+
- name: Checkout
|
|
29
|
+
uses: actions/checkout@v4
|
|
30
|
+
|
|
31
|
+
- name: Setup Pages
|
|
32
|
+
uses: actions/configure-pages@v5
|
|
33
|
+
|
|
34
|
+
- name: Upload artifact
|
|
35
|
+
uses: actions/upload-pages-artifact@v3
|
|
36
|
+
with:
|
|
37
|
+
path: docs
|
|
38
|
+
|
|
39
|
+
- name: Deploy to GitHub Pages
|
|
40
|
+
id: deployment
|
|
41
|
+
uses: actions/deploy-pages@v4
|
package/CHANGELOG.md
CHANGED
|
@@ -5,11 +5,59 @@ All notable changes to this project will be documented in this file.
|
|
|
5
5
|
|
|
6
6
|
|
|
7
7
|
|
|
8
|
+
## [1.3.1] - 2026-03-07
|
|
8
9
|
|
|
10
|
+
### Improvements
|
|
9
11
|
|
|
12
|
+
- Improve sync robustness during rapid consecutive file changes
|
|
13
|
+
- Enhance incremental change processor to reduce false-positive conflict detection
|
|
14
|
+
- Strengthen sync index integrity checks on startup and reconnect
|
|
15
|
+
- Improve LRU cache eviction to prevent stale place data after session switch
|
|
10
16
|
|
|
17
|
+
### Bug Fixes
|
|
18
|
+
|
|
19
|
+
- Fix sync stall when file watcher emits duplicate events for the same path
|
|
20
|
+
- Fix reverse sync occasionally skipping files with identical hashes but different timestamps
|
|
21
|
+
- Fix collision suffix (`~N`) not reindexing correctly after instance rename
|
|
22
|
+
- Fix sync-init phase hanging when workspace contains deeply nested empty containers
|
|
23
|
+
|
|
24
|
+
### Documentation
|
|
25
|
+
|
|
26
|
+
- Restructure README for faster install path (Quick Install and compatibility table at top)
|
|
27
|
+
- Add troubleshooting guide
|
|
28
|
+
- Add compatibility matrix (supported clients, system requirements, Basic vs Pro)
|
|
29
|
+
- Add `llms.txt` for AI crawler discovery
|
|
30
|
+
- Add community health files: CONTRIBUTING, CODE_OF_CONDUCT, SECURITY, SUPPORT
|
|
31
|
+
- Add GitHub issue templates (bug report, feature request, install help)
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
## [1.3.0] - 2026-03-06
|
|
35
|
+
|
|
36
|
+
### Breaking Changes
|
|
37
|
+
|
|
38
|
+
- Sync file format now uses nested directory structure for all objects — each instance is represented as its own directory (e.g., `Part/Part.props.json` instead of flat files)
|
|
39
|
+
- Duplicate sibling instances are now distinguished using `~N` suffix encoding (Odd-Count Tilde Rule) — e.g., `Part~1/`, `Part~2/`, `Part~3/`
|
|
40
|
+
- Existing sync data will be regenerated automatically (no migration from v1)
|
|
41
|
+
|
|
42
|
+
### Improvements
|
|
43
|
+
|
|
44
|
+
- Enhance sync stability and performance for bidirectional file synchronization
|
|
45
|
+
- Improve sync child indexing and collision handling
|
|
46
|
+
- Refine analytics tracking for tool usage
|
|
47
|
+
|
|
48
|
+
### Bug Fixes
|
|
49
|
+
|
|
50
|
+
- Improve error handling and resilience during MCP tool execution
|
|
51
|
+
- Fix license token cache and Pro auth flow issues
|
|
52
|
+
- Resolve sync errors on concurrent file changes
|
|
53
|
+
- Fix duplicated instance name handling in sync index
|
|
54
|
+
- Fix various edge cases in sync change processing
|
|
11
55
|
|
|
56
|
+
### Plugin
|
|
12
57
|
|
|
58
|
+
- Improve plugin icons and UI refinements
|
|
59
|
+
- Clean up unused files and modules
|
|
60
|
+
- General plugin stability improvements
|
|
13
61
|
|
|
14
62
|
|
|
15
63
|
## [1.2.3] - 2026-03-02
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# Code of Conduct
|
|
2
|
+
|
|
3
|
+
## Our Pledge
|
|
4
|
+
|
|
5
|
+
We are committed to making participation in this project a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity, level of experience, nationality, personal appearance, race, religion, or sexual identity.
|
|
6
|
+
|
|
7
|
+
## Our Standards
|
|
8
|
+
|
|
9
|
+
Examples of behavior that contributes to a positive environment:
|
|
10
|
+
|
|
11
|
+
- Using welcoming and inclusive language
|
|
12
|
+
- Being respectful of differing viewpoints and experiences
|
|
13
|
+
- Gracefully accepting constructive criticism
|
|
14
|
+
- Focusing on what is best for the community
|
|
15
|
+
- Showing empathy toward other community members
|
|
16
|
+
|
|
17
|
+
Examples of unacceptable behavior:
|
|
18
|
+
|
|
19
|
+
- Harassment, trolling, or personal attacks
|
|
20
|
+
- Publishing others' private information without permission
|
|
21
|
+
- Other conduct which could reasonably be considered inappropriate
|
|
22
|
+
|
|
23
|
+
## Enforcement
|
|
24
|
+
|
|
25
|
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting the maintainer via [GitHub Discussions](https://github.com/hope1026/roblox-mcp/discussions). All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate.
|
|
26
|
+
|
|
27
|
+
## Attribution
|
|
28
|
+
|
|
29
|
+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/), version 2.1.
|
package/CONTRIBUTING.md
ADDED
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# Contributing to Roblox MCP
|
|
2
|
+
|
|
3
|
+
## Bug Reports
|
|
4
|
+
|
|
5
|
+
Use the [Bug Report issue template](https://github.com/hope1026/roblox-mcp/issues/new?template=bug_report.yml).
|
|
6
|
+
|
|
7
|
+
Include:
|
|
8
|
+
- OS and Node.js version (`node --version`)
|
|
9
|
+
- Roblox Studio version
|
|
10
|
+
- AI client and version
|
|
11
|
+
- Steps to reproduce
|
|
12
|
+
- Expected vs actual behavior
|
|
13
|
+
- Error logs if available
|
|
14
|
+
|
|
15
|
+
## Feature Requests
|
|
16
|
+
|
|
17
|
+
Use the [Feature Request template](https://github.com/hope1026/roblox-mcp/issues/new?template=feature_request.yml).
|
|
18
|
+
|
|
19
|
+
## Questions & Install Help
|
|
20
|
+
|
|
21
|
+
Use [GitHub Discussions](https://github.com/hope1026/roblox-mcp/discussions) — not Issues — for questions and install help.
|
|
22
|
+
|
|
23
|
+
## Pull Requests
|
|
24
|
+
|
|
25
|
+
This repository distributes the MCP server and plugin. The plugin source is not included here.
|
|
26
|
+
|
|
27
|
+
PRs for **documentation improvements** and **example prompts** are welcome:
|
|
28
|
+
|
|
29
|
+
1. Fork the repository
|
|
30
|
+
2. Create a branch: `git checkout -b docs/your-improvement`
|
|
31
|
+
3. Make your changes
|
|
32
|
+
4. Open a Pull Request with a clear description
|
|
33
|
+
|
|
34
|
+
## Code of Conduct
|
|
35
|
+
|
|
36
|
+
Please read and follow the [Code of Conduct](CODE_OF_CONDUCT.md).
|
package/README.md
CHANGED
|
@@ -1,16 +1,44 @@
|
|
|
1
1
|
# Roblox MCP
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
> MCP server and plugin for Roblox Studio — control scripts, terrain, assets, and lighting with Claude Code, Cursor, Codex, and Gemini.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
**English** | [한국어](docs/ko/README.md) | [日本語](docs/ja/README.md) | [Español](docs/es/README.md) | [Português](docs/pt-br/README.md) | [Bahasa Indonesia](docs/id/README.md)
|
|
6
6
|
|
|
7
7
|
[](https://youtu.be/3jrUpBbZPaw)
|
|
8
8
|
|
|
9
|
-
##
|
|
9
|
+
## Quick Install (5 minutes)
|
|
10
|
+
|
|
11
|
+
**Step 1** — Install the Roblox Studio plugin (bridge between Studio and AI):
|
|
12
|
+
[Plugin Installation Guide](docs/en/installation/roblox-plugin.md)
|
|
13
|
+
|
|
14
|
+
**Step 2** — Register the MCP server with your AI app:
|
|
15
|
+
|
|
16
|
+
```bash
|
|
17
|
+
npx -y @weppy/roblox-mcp
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
| AI App | Guide |
|
|
21
|
+
|--------|-------|
|
|
22
|
+
| Claude Code | [Setup](docs/en/installation/ai-apps/claude-code.md) |
|
|
23
|
+
| Claude Desktop | [Setup](docs/en/installation/ai-apps/claude-app.md) |
|
|
24
|
+
| Codex CLI | [Setup](docs/en/installation/ai-apps/codex-cli.md) |
|
|
25
|
+
| Codex Desktop | [Setup](docs/en/installation/ai-apps/codex-app.md) |
|
|
26
|
+
| Gemini CLI | [Setup](docs/en/installation/ai-apps/gemini-cli.md) |
|
|
27
|
+
|
|
28
|
+
> Any MCP-compatible AI client works. The server command is `npx -y @weppy/roblox-mcp`.
|
|
29
|
+
|
|
30
|
+
## Compatibility
|
|
31
|
+
|
|
32
|
+
| Claude Code | Claude Desktop | Cursor | Codex CLI | Gemini CLI |
|
|
33
|
+
|:-----------:|:--------------:|:------:|:---------:|:----------:|
|
|
34
|
+
| ✅ | ✅ | ✅ | ✅ | ✅ |
|
|
35
|
+
|
|
36
|
+
**Requirements:** Node.js 18+, Roblox Studio, Windows 10+ or macOS 12+
|
|
37
|
+
|
|
38
|
+
## What It Does
|
|
10
39
|
|
|
11
40
|
### 1) MCP Tools: Direct execution in Studio from natural language
|
|
12
41
|
|
|
13
|
-
The first pillar of Roblox MCP is **MCP tool execution**.
|
|
14
42
|
AI can directly handle scripts, instances, properties, terrain, lighting, assets, audio, and animation inside Studio.
|
|
15
43
|
|
|
16
44
|
- "Add particles + sound + cooldown when the player jumps."
|
|
@@ -21,7 +49,6 @@ This is not just code generation. It is **executable, production-oriented action
|
|
|
21
49
|
|
|
22
50
|
### 2) Sync: Keep full project context stable for AI
|
|
23
51
|
|
|
24
|
-
The second pillar is **Project Sync**.
|
|
25
52
|
AI works from a synchronized local mirror, so multi-file updates stay consistent.
|
|
26
53
|
|
|
27
54
|

|
|
@@ -29,36 +56,27 @@ AI works from a synchronized local mirror, so multi-file updates stay consistent
|
|
|
29
56
|
- Basic: one-way sync (Studio -> Local)
|
|
30
57
|
- Pro: bidirectional sync + per-type Direction/Apply Mode + history + multi-place
|
|
31
58
|
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
## Immediate Value
|
|
59
|
+
## Why It Matters
|
|
35
60
|
|
|
36
61
|
- Compress repetitive work: turn many manual edits into one request
|
|
37
62
|
- Change related files together: not just one target file
|
|
38
63
|
- Lower risk: rely on sync state and history before applying changes
|
|
39
64
|
- Better token efficiency (Pro): reduce round trips with bulk actions
|
|
40
65
|
|
|
41
|
-
##
|
|
66
|
+
## Docs
|
|
42
67
|
|
|
43
|
-
- [
|
|
68
|
+
- [Installation Guide](docs/en/installation/README.md)
|
|
69
|
+
- [Tools Reference](docs/en/tools/overview.md)
|
|
44
70
|
- [Sync Deep Dive](docs/en/sync/overview.md)
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
Installation is complete in two steps:
|
|
49
|
-
|
|
50
|
-
1. **Install Roblox Studio Plugin** — Acts as a bridge between Studio and AI
|
|
51
|
-
2. **Register MCP Server with AI App** — Configure your AI app to recognize Roblox MCP
|
|
52
|
-
|
|
53
|
-
Takes just 5 minutes. 👉 [View Installation Guide](docs/en/installation/README.md)
|
|
71
|
+
- [Compatibility](docs/compatibility.md)
|
|
72
|
+
- [Troubleshooting](docs/troubleshooting.md)
|
|
54
73
|
|
|
55
74
|
## Pro Upgrade
|
|
56
75
|
|
|
57
76
|
Bidirectional Sync, advanced build capabilities, and AI token efficiency — all in one upgrade.
|
|
58
77
|
|
|
59
|
-
|
|
78
|
+
[Pro Upgrade Guide](docs/en/pro-upgrade.md)
|
|
60
79
|
|
|
61
|
-
|
|
80
|
+
---
|
|
62
81
|
|
|
63
|
-
- [
|
|
64
|
-
- [Issue Reports](https://github.com/hope1026/roblox-mcp/issues)
|
|
82
|
+
[GitHub Issues](https://github.com/hope1026/roblox-mcp/issues) · [Discussions](https://github.com/hope1026/roblox-mcp/discussions) · [npm](https://www.npmjs.com/package/@weppy/roblox-mcp)
|
package/SECURITY.md
ADDED
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# Security Policy
|
|
2
|
+
|
|
3
|
+
## Supported Versions
|
|
4
|
+
|
|
5
|
+
| Version | Supported |
|
|
6
|
+
|---------|-----------|
|
|
7
|
+
| 1.x (latest) | ✅ |
|
|
8
|
+
| < 1.0 | ❌ |
|
|
9
|
+
|
|
10
|
+
## Reporting a Vulnerability
|
|
11
|
+
|
|
12
|
+
Do **not** open a public GitHub issue for security vulnerabilities.
|
|
13
|
+
|
|
14
|
+
Report security issues via [GitHub Issues](https://github.com/hope1026/roblox-mcp/issues/new) with the title prefixed `[SECURITY]`, or contact the maintainer via [GitHub Discussions](https://github.com/hope1026/roblox-mcp/discussions).
|
|
15
|
+
|
|
16
|
+
We will respond within 72 hours and aim to release a fix within 14 days for confirmed vulnerabilities.
|
|
17
|
+
|
|
18
|
+
## Scope
|
|
19
|
+
|
|
20
|
+
- MCP server HTTP bridge (localhost:3002)
|
|
21
|
+
- Plugin authentication and session token handling
|
|
22
|
+
- License server communication
|
|
23
|
+
|
|
24
|
+
## Out of Scope
|
|
25
|
+
|
|
26
|
+
- Roblox Studio itself
|
|
27
|
+
- Third-party AI client security
|
|
28
|
+
- Issues requiring physical access to the machine
|
package/SUPPORT.md
ADDED
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# Support
|
|
2
|
+
|
|
3
|
+
## Documentation
|
|
4
|
+
|
|
5
|
+
- [Installation Guide](docs/en/installation/README.md)
|
|
6
|
+
- [Tools Reference](docs/en/tools/overview.md)
|
|
7
|
+
- [Sync Deep Dive](docs/en/sync/overview.md)
|
|
8
|
+
- [Compatibility](docs/en/compatibility.md)
|
|
9
|
+
- [Troubleshooting](docs/en/troubleshooting.md)
|
|
10
|
+
|
|
11
|
+
## Community Help
|
|
12
|
+
|
|
13
|
+
For questions and install issues, use [GitHub Discussions](https://github.com/hope1026/roblox-mcp/discussions).
|
|
14
|
+
|
|
15
|
+
Please include:
|
|
16
|
+
- Your OS and Node.js version
|
|
17
|
+
- AI client you're using
|
|
18
|
+
- What you've already tried
|
|
19
|
+
|
|
20
|
+
## Bug Reports
|
|
21
|
+
|
|
22
|
+
For confirmed bugs, open an [Issue](https://github.com/hope1026/roblox-mcp/issues/new?template=bug_report.yml).
|
|
23
|
+
|
|
24
|
+
## Pro Users
|
|
25
|
+
|
|
26
|
+
Pro users can reach out via the contact information provided in your Gumroad receipt.
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
# Compatibility
|
|
2
|
+
|
|
3
|
+
## Supported AI Clients
|
|
4
|
+
|
|
5
|
+
| Client | Basic | Pro | Setup guide |
|
|
6
|
+
|--------|:-----:|:---:|-------------|
|
|
7
|
+
| Claude Code | ✅ | ✅ | [Guide](en/installation/ai-apps/claude-code.md) |
|
|
8
|
+
| Claude Desktop | ✅ | ✅ | [Guide](en/installation/ai-apps/claude-app.md) |
|
|
9
|
+
| Cursor | ✅ | ✅ | MCP config: `npx -y @weppy/roblox-mcp` |
|
|
10
|
+
| Codex CLI | ✅ | ✅ | [Guide](en/installation/ai-apps/codex-cli.md) |
|
|
11
|
+
| Codex Desktop | ✅ | ✅ | [Guide](en/installation/ai-apps/codex-app.md) |
|
|
12
|
+
| Gemini CLI | ✅ | ✅ | [Guide](en/installation/ai-apps/gemini-cli.md) |
|
|
13
|
+
| Any MCP client | ✅ | ✅ | Server command: `npx -y @weppy/roblox-mcp` |
|
|
14
|
+
|
|
15
|
+
## System Requirements
|
|
16
|
+
|
|
17
|
+
| Requirement | Minimum |
|
|
18
|
+
|-------------|---------|
|
|
19
|
+
| Node.js | 18.0.0+ |
|
|
20
|
+
| Roblox Studio | Latest (keep auto-updated) |
|
|
21
|
+
| OS | Windows 10+ or macOS 12+ |
|
|
22
|
+
| Network | localhost:3002 must be accessible |
|
|
23
|
+
|
|
24
|
+
## Feature Matrix (Basic vs Pro)
|
|
25
|
+
|
|
26
|
+
| Feature | Basic | Pro |
|
|
27
|
+
|---------|:-----:|:---:|
|
|
28
|
+
| MCP tool execution (scripts, instances, properties) | ✅ | ✅ |
|
|
29
|
+
| Studio → Local one-way sync | ✅ | ✅ |
|
|
30
|
+
| Bidirectional sync (Local → Studio) | ❌ | ✅ |
|
|
31
|
+
| Per-type Direction and Apply Mode | ❌ | ✅ |
|
|
32
|
+
| Sync history and changelog | ❌ | ✅ |
|
|
33
|
+
| Multi-place support (up to 3 places) | ❌ | ✅ |
|
|
34
|
+
| Bulk operations (mass_create, mass_set) | ❌ | ✅ |
|
|
35
|
+
| Advanced spatial queries | ❌ | ✅ |
|
|
36
|
+
| Terrain generation and fill | ❌ | ✅ |
|
|
37
|
+
| Physics group management | ❌ | ✅ |
|
|
38
|
+
| Tween and animation control | ❌ | ✅ |
|
|
39
|
+
| Audio control | ❌ | ✅ |
|
|
40
|
+
| Lighting and atmosphere | ❌ | ✅ |
|
|
41
|
+
|
|
42
|
+
## MCP Tool Count
|
|
43
|
+
|
|
44
|
+
21 consolidated tools with action-based sub-commands. See [Tools Reference](en/tools/overview.md) for the full list.
|
package/docs/en/sync/overview.md
CHANGED
|
@@ -110,6 +110,30 @@ When changes are detected on both Studio and local sides during bidirectional sy
|
|
|
110
110
|
- Inspect target file with `read_file`
|
|
111
111
|
- Restore content with `write_file`, then verify Studio state
|
|
112
112
|
|
|
113
|
+
## File format (v2 nested directory)
|
|
114
|
+
|
|
115
|
+
Each Roblox instance is stored as its own directory containing meta files:
|
|
116
|
+
|
|
117
|
+
```
|
|
118
|
+
explorer/
|
|
119
|
+
├── Workspace/
|
|
120
|
+
│ ├── _tree.json
|
|
121
|
+
│ ├── Part/
|
|
122
|
+
│ │ └── Part.props.json
|
|
123
|
+
│ ├── MyScript/
|
|
124
|
+
│ │ └── MyScript.server.luau
|
|
125
|
+
│ └── Coins/
|
|
126
|
+
│ └── Coins.value.json
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
Naming conventions:
|
|
130
|
+
- Props: `{Name}/{Name}.props.json`
|
|
131
|
+
- Scripts: `{Name}/{Name}.server.luau` / `.client.luau` / `.module.luau`
|
|
132
|
+
- Values: `{Name}/{Name}.value.json`
|
|
133
|
+
|
|
134
|
+
Duplicate instance names use `~N` suffix on the directory (e.g. `Part~2/Part.props.json`).
|
|
135
|
+
Names containing `~` are escaped to `~~` (e.g. `Part~2` becomes `Part~~2/`). The Odd-Count Tilde Rule applies: a trailing `~+N` is a collision suffix only when the tilde count is odd.
|
|
136
|
+
|
|
113
137
|
## Related docs
|
|
114
138
|
|
|
115
139
|
- [Tools Overview](../tools/overview.md)
|
package/docs/es/README.md
CHANGED
|
@@ -1,16 +1,44 @@
|
|
|
1
1
|
# Roblox MCP
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
> Servidor MCP y plugin para Roblox Studio — controla scripts, terrain, assets e iluminacion con Claude Code, Cursor, Codex y Gemini.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
[English](../../README.md) | [한국어](../ko/README.md) | [日本語](../ja/README.md) | **Español** | [Português](../pt-br/README.md) | [Bahasa Indonesia](../id/README.md)
|
|
6
6
|
|
|
7
7
|
[](https://youtu.be/3jrUpBbZPaw)
|
|
8
8
|
|
|
9
|
+
## Instalacion rapida (5 minutos)
|
|
10
|
+
|
|
11
|
+
**Paso 1** — Instala el plugin de Roblox Studio (puente entre Studio e IA):
|
|
12
|
+
[Guia de instalacion del plugin](../en/installation/roblox-plugin.md)
|
|
13
|
+
|
|
14
|
+
**Paso 2** — Registra el servidor MCP en tu app de IA:
|
|
15
|
+
|
|
16
|
+
```bash
|
|
17
|
+
npx -y @weppy/roblox-mcp
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
| App de IA | Guia |
|
|
21
|
+
|-----------|------|
|
|
22
|
+
| Claude Code | [Configuracion](../en/installation/ai-apps/claude-code.md) |
|
|
23
|
+
| Claude Desktop | [Configuracion](../en/installation/ai-apps/claude-app.md) |
|
|
24
|
+
| Codex CLI | [Configuracion](../en/installation/ai-apps/codex-cli.md) |
|
|
25
|
+
| Codex Desktop | [Configuracion](../en/installation/ai-apps/codex-app.md) |
|
|
26
|
+
| Gemini CLI | [Configuracion](../en/installation/ai-apps/gemini-cli.md) |
|
|
27
|
+
|
|
28
|
+
> Funciona con cualquier cliente MCP compatible. El comando del servidor es `npx -y @weppy/roblox-mcp`.
|
|
29
|
+
|
|
30
|
+
## Compatibilidad
|
|
31
|
+
|
|
32
|
+
| Claude Code | Claude Desktop | Cursor | Codex CLI | Gemini CLI |
|
|
33
|
+
|:-----------:|:--------------:|:------:|:---------:|:----------:|
|
|
34
|
+
| ✅ | ✅ | ✅ | ✅ | ✅ |
|
|
35
|
+
|
|
36
|
+
**Requisitos:** Node.js 18+, Roblox Studio, Windows 10+ o macOS 12+
|
|
37
|
+
|
|
9
38
|
## Funciones principales
|
|
10
39
|
|
|
11
40
|
### 1) MCP Tool: ejecuta en Studio desde lenguaje natural
|
|
12
41
|
|
|
13
|
-
El primer eje de Roblox MCP es la **ejecucion de MCP Tool**.
|
|
14
42
|
La IA puede manejar directamente scripts, instancias, propiedades, terreno, iluminacion, assets, audio y animacion dentro de Studio.
|
|
15
43
|
|
|
16
44
|
- "Agrega particulas + sonido + cooldown cuando el jugador salte."
|
|
@@ -21,7 +49,6 @@ No es solo generacion de codigo. Son **acciones ejecutables orientadas a producc
|
|
|
21
49
|
|
|
22
50
|
### 2) Sync: mantiene el contexto completo del proyecto
|
|
23
51
|
|
|
24
|
-
El segundo eje es **Project Sync**.
|
|
25
52
|
La IA trabaja sobre un espejo local sincronizado, asi que los cambios en multiples archivos se mantienen consistentes.
|
|
26
53
|
|
|
27
54
|

|
|
@@ -29,8 +56,6 @@ La IA trabaja sobre un espejo local sincronizado, asi que los cambios en multipl
|
|
|
29
56
|
- Basic: sincronizacion unidireccional (Studio -> Local)
|
|
30
57
|
- Pro: sincronizacion bidireccional + Direction/Apply Mode por tipo + historial + multiplace
|
|
31
58
|
|
|
32
|
-
Asi mantienes claro cual es la fuente de verdad y no pierdes contexto de cambios.
|
|
33
|
-
|
|
34
59
|
## Valor inmediato para el usuario
|
|
35
60
|
|
|
36
61
|
- Comprime trabajo repetitivo: convierte muchas ediciones manuales en una sola instruccion
|
|
@@ -40,25 +65,18 @@ Asi mantienes claro cual es la fuente de verdad y no pierdes contexto de cambios
|
|
|
40
65
|
|
|
41
66
|
## Documentacion detallada
|
|
42
67
|
|
|
43
|
-
- [
|
|
44
|
-
- [
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
La instalacion se completa en dos pasos:
|
|
49
|
-
|
|
50
|
-
1. **Instalar el plugin de Roblox Studio** — Hace de puente entre Studio e IA
|
|
51
|
-
2. **Registrar el servidor MCP en tu app de IA** — Para que la app de IA lo reconozca
|
|
52
|
-
|
|
53
|
-
Solo toma 5 minutos. 👉 [Ver guia de instalacion](installation/README.md)
|
|
68
|
+
- [Guia de instalacion](../en/installation/README.md)
|
|
69
|
+
- [Cobertura de herramientas](../en/tools/overview.md)
|
|
70
|
+
- [Guia detallada de Sync](../en/sync/overview.md)
|
|
71
|
+
- [Compatibilidad](../compatibility.md)
|
|
72
|
+
- [Solucion de problemas](../troubleshooting.md)
|
|
54
73
|
|
|
55
74
|
## Upgrade Pro
|
|
56
75
|
|
|
57
76
|
Sync bidireccional, capacidades de creacion avanzadas y eficiencia de tokens de IA — todo en una sola actualizacion.
|
|
58
77
|
|
|
59
|
-
|
|
78
|
+
[Guia de actualizacion Pro](../en/pro-upgrade.md)
|
|
60
79
|
|
|
61
|
-
|
|
80
|
+
---
|
|
62
81
|
|
|
63
|
-
- [
|
|
64
|
-
- [Reportar problemas](https://github.com/hope1026/roblox-mcp/issues)
|
|
82
|
+
[GitHub Issues](https://github.com/hope1026/roblox-mcp/issues) · [Discussions](https://github.com/hope1026/roblox-mcp/discussions) · [npm](https://www.npmjs.com/package/@weppy/roblox-mcp)
|