@satelliteoflove/godot-mcp 0.1.6 → 1.0.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.
- package/README.md +52 -9
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -1,34 +1,77 @@
|
|
|
1
1
|
# @satelliteoflove/godot-mcp
|
|
2
2
|
|
|
3
|
-
MCP (Model Context Protocol) server for Godot Engine integration. Enables AI assistants to interact with the Godot editor.
|
|
3
|
+
MCP (Model Context Protocol) server for Godot Engine integration. Enables AI assistants like Claude to interact with the Godot editor in real-time.
|
|
4
|
+
|
|
5
|
+
## Features
|
|
6
|
+
|
|
7
|
+
- **33 MCP tools** across 8 categories (scene, node, script, editor, project, screenshot, animation, tilemap)
|
|
8
|
+
- **3 MCP resources** for reading scene trees, scripts, and project files
|
|
9
|
+
- Real-time bidirectional communication via WebSocket
|
|
10
|
+
- Debug output and screenshot capture from running games
|
|
11
|
+
- Full TileMapLayer and GridMap editing support
|
|
12
|
+
- Animation query, playback, and editing
|
|
4
13
|
|
|
5
14
|
## Requirements
|
|
6
15
|
|
|
7
|
-
- Node.js
|
|
8
|
-
- Godot 4.5+
|
|
16
|
+
- Node.js 20+
|
|
17
|
+
- Godot 4.5+ (required for Logger class)
|
|
9
18
|
- The Godot MCP addon installed in your project
|
|
10
19
|
|
|
11
20
|
## Installation
|
|
12
21
|
|
|
22
|
+
Use directly with npx (recommended):
|
|
23
|
+
|
|
13
24
|
```bash
|
|
14
|
-
|
|
25
|
+
npx @satelliteoflove/godot-mcp
|
|
15
26
|
```
|
|
16
27
|
|
|
17
|
-
Or
|
|
28
|
+
Or install globally:
|
|
18
29
|
|
|
19
30
|
```bash
|
|
20
|
-
|
|
31
|
+
npm install -g @satelliteoflove/godot-mcp
|
|
21
32
|
```
|
|
22
33
|
|
|
23
34
|
## Setup
|
|
24
35
|
|
|
25
|
-
1.
|
|
36
|
+
1. Copy the Godot addon from `godot/addons/godot_mcp` into your project's `addons` folder
|
|
26
37
|
2. Enable the addon in Project Settings > Plugins
|
|
27
|
-
3. Configure your MCP client
|
|
38
|
+
3. Configure your MCP client (see below)
|
|
39
|
+
|
|
40
|
+
### Claude Desktop Configuration
|
|
41
|
+
|
|
42
|
+
Add to your config file:
|
|
43
|
+
- macOS: `~/Library/Application Support/Claude/claude_desktop_config.json`
|
|
44
|
+
- Windows: `%APPDATA%\Claude\claude_desktop_config.json`
|
|
45
|
+
|
|
46
|
+
```json
|
|
47
|
+
{
|
|
48
|
+
"mcpServers": {
|
|
49
|
+
"godot-mcp": {
|
|
50
|
+
"command": "npx",
|
|
51
|
+
"args": ["-y", "@satelliteoflove/godot-mcp"]
|
|
52
|
+
}
|
|
53
|
+
}
|
|
54
|
+
}
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
### Claude Code Configuration
|
|
58
|
+
|
|
59
|
+
Add to your project's `.mcp.json`:
|
|
60
|
+
|
|
61
|
+
```json
|
|
62
|
+
{
|
|
63
|
+
"mcpServers": {
|
|
64
|
+
"godot-mcp": {
|
|
65
|
+
"command": "npx",
|
|
66
|
+
"args": ["-y", "@satelliteoflove/godot-mcp"]
|
|
67
|
+
}
|
|
68
|
+
}
|
|
69
|
+
}
|
|
70
|
+
```
|
|
28
71
|
|
|
29
72
|
## Documentation
|
|
30
73
|
|
|
31
|
-
For full documentation, setup guides, and the Godot addon, visit the [GitHub repository](https://github.com/satelliteoflove/godot-mcp).
|
|
74
|
+
For full API documentation, setup guides, and the Godot addon source, visit the [GitHub repository](https://github.com/satelliteoflove/godot-mcp).
|
|
32
75
|
|
|
33
76
|
## License
|
|
34
77
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@satelliteoflove/godot-mcp",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "1.0.0",
|
|
4
4
|
"description": "MCP server for Godot Engine integration",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "dist/index.js",
|
|
@@ -50,6 +50,6 @@
|
|
|
50
50
|
"vitest": "^2.1.0"
|
|
51
51
|
},
|
|
52
52
|
"engines": {
|
|
53
|
-
"node": ">=
|
|
53
|
+
"node": ">=20.0.0"
|
|
54
54
|
}
|
|
55
55
|
}
|