@satelliteoflove/godot-mcp 2.0.2 → 2.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.
- package/README.md +16 -29
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,51 +1,33 @@
|
|
|
1
1
|
# @satelliteoflove/godot-mcp
|
|
2
2
|
|
|
3
|
-
MCP
|
|
3
|
+
MCP server for Godot Engine 4.5+, enabling AI assistants to interact with your Godot projects.
|
|
4
4
|
|
|
5
5
|
## Features
|
|
6
6
|
|
|
7
|
-
|
|
8
|
-
- **8 MCP tools** for scene, node, editor, project, animation, tilemap, resource operations
|
|
7
|
+
- **8 MCP tools** across 7 categories
|
|
9
8
|
- **3 MCP resources** for reading scene trees, scripts, and project files
|
|
10
|
-
- Real-time bidirectional communication via WebSocket
|
|
11
9
|
- Screenshot capture from editor viewports and running games
|
|
12
10
|
- Full animation support (query, playback, editing)
|
|
13
11
|
- TileMapLayer and GridMap editing
|
|
14
12
|
- Resource inspection for SpriteFrames, TileSets, Materials, and Textures
|
|
15
13
|
- Debug output capture from running games
|
|
16
|
-
<!-- NPM_FEATURES_END -->
|
|
17
|
-
|
|
18
|
-
## Requirements
|
|
19
|
-
|
|
20
|
-
- Node.js 20+
|
|
21
|
-
- Godot 4.5+ (required for Logger class)
|
|
22
|
-
- The Godot MCP addon installed in your project
|
|
23
14
|
|
|
24
15
|
## Installation
|
|
25
16
|
|
|
26
|
-
Use directly with npx (recommended):
|
|
27
|
-
|
|
28
17
|
```bash
|
|
29
18
|
npx @satelliteoflove/godot-mcp
|
|
30
19
|
```
|
|
31
20
|
|
|
32
|
-
Or install globally:
|
|
33
|
-
|
|
34
|
-
```bash
|
|
35
|
-
npm install -g @satelliteoflove/godot-mcp
|
|
36
|
-
```
|
|
37
|
-
|
|
38
21
|
## Setup
|
|
39
22
|
|
|
40
|
-
1.
|
|
41
|
-
2.
|
|
42
|
-
3.
|
|
23
|
+
1. Download the addon from [GitHub Releases](https://github.com/satelliteoflove/godot-mcp/releases)
|
|
24
|
+
2. Extract to your project's `addons` directory
|
|
25
|
+
3. Enable it in Project Settings > Plugins
|
|
26
|
+
4. Configure your MCP client (see below)
|
|
43
27
|
|
|
44
|
-
### Claude Desktop
|
|
28
|
+
### Claude Desktop
|
|
45
29
|
|
|
46
|
-
Add to
|
|
47
|
-
- macOS: `~/Library/Application Support/Claude/claude_desktop_config.json`
|
|
48
|
-
- Windows: `%APPDATA%\Claude\claude_desktop_config.json`
|
|
30
|
+
Add to `~/Library/Application Support/Claude/claude_desktop_config.json` (macOS) or `%APPDATA%\Claude\claude_desktop_config.json` (Windows):
|
|
49
31
|
|
|
50
32
|
```json
|
|
51
33
|
{
|
|
@@ -58,9 +40,9 @@ Add to your config file:
|
|
|
58
40
|
}
|
|
59
41
|
```
|
|
60
42
|
|
|
61
|
-
### Claude Code
|
|
43
|
+
### Claude Code
|
|
62
44
|
|
|
63
|
-
Add to
|
|
45
|
+
Add to `.mcp.json`:
|
|
64
46
|
|
|
65
47
|
```json
|
|
66
48
|
{
|
|
@@ -75,7 +57,12 @@ Add to your project's `.mcp.json`:
|
|
|
75
57
|
|
|
76
58
|
## Documentation
|
|
77
59
|
|
|
78
|
-
|
|
60
|
+
See the [GitHub repository](https://github.com/satelliteoflove/godot-mcp) for full documentation.
|
|
61
|
+
|
|
62
|
+
## Requirements
|
|
63
|
+
|
|
64
|
+
- Node.js 20+
|
|
65
|
+
- Godot 4.5+
|
|
79
66
|
|
|
80
67
|
## License
|
|
81
68
|
|