Skip to content

tomyud1/godot-mcp

Repository files navigation

Godot MCP

Give your AI assistant full access to the Godot editor.

Build games faster with Claude, Cursor, or any MCP-compatible AI — no copy-pasting, no context switching. AI reads, writes, and manipulates your scenes, scripts, nodes, and project settings directly.

Godot 4.x · 42 tools · Interactive project visualizer · MIT license


Quick Start

0. Install Node.js (one-time setup)

Download and run the installer from nodejs.org (LTS version). It's a standard installer — no terminal needed.

1. Install the Godot plugin

Inside the Godot editor, click the AssetLib tab at the top → search "mcp" → find "Godot AI Assistant tools MCP" → Install.

Then go to Project → Project Settings → Plugins and enable the Godot MCP plugin.

2. Add the server config to your AI client

Claude Desktop — Settings → Developer → Edit Config → open the config file and paste:

Mac / Linux:

{
  "mcpServers": {
    "godot": {
      "command": "npx",
      "args": ["-y", "godot-mcp-server"]
    }
  }
}

Windows:

{
  "mcpServers": {
    "godot": {
      "command": "cmd",
      "args": ["/c", "npx", "-y", "godot-mcp-server"]
    }
  }
}

Cursor — Settings → MCP → Add Server:

Mac / Linux:

{
  "mcpServers": {
    "godot": {
      "command": "npx",
      "args": ["-y", "godot-mcp-server"]
    }
  }
}

Windows:

{
  "mcpServers": {
    "godot": {
      "command": "cmd",
      "args": ["/c", "npx", "-y", "godot-mcp-server"]
    }
  }
}

Claude Code — run in terminal:

claude mcp add godot -- npx -y godot-mcp-server

Works with any MCP-compatible client (Cline, Windsurf, etc.)

3. Restart your AI client

Close and reopen Claude Desktop / Cursor / your client so it picks up the new config.

4. Restart your Godot project

Hit Restart Project in the Godot editor. Check the top-right corner — you should see MCP Connected in green. You're ready to go.


What Can It Do?

42 Tools Across 6 Categories

Category Tools Examples
File Operations 4 Browse directories, read files, search project, create scripts
Scene Operations 11 Create scenes, add/remove/move nodes, set properties, attach scripts, assign collision shapes and textures
Script Operations 6 Apply code edits, validate syntax, rename/move files with reference updates
Project Tools 14 Run/stop scenes, query ClassDB, read errors from Output + Debugger, project settings, input map, collision layers, scene tree dumps, rescan filesystem
Asset Generation 1 Generate 2D sprites from SVG
Visualization 6 Interactive browser-based project map, scene graph explorer

Interactive Visualizer

Run map_project and get a browser-based explorer at localhost:6510:

  • Force-directed graph of all scripts and their relationships
  • Click any script to see variables, functions, signals, and connections
  • Edit code directly in the visualizer — changes sync to Godot in real time
  • Scene view with node property editing
  • Find usages before refactoring
image

Limitations

AI cannot create 100% of a game by itself — it struggles with complex UI layouts, compositing scenes, and some node property manipulation. It's still in active development, so feedback is very welcome!


Architecture

┌─────────────┐    MCP (stdio)   ┌──────────────┐   WebSocket   ┌──────────────┐
│  AI Client  │◄────────────────►│  MCP Server  │◄─────────────►│ Godot Editor │
│  (Claude,   │                  │  (Node.js)   │   port 6505   │  (Plugin)    │
│   Cursor)   │                  │              │               │              │
└─────────────┘                  │  Visualizer  │               │  42 tool     │
                                 │  HTTP :6510  │               │  handlers    │
                                 └──────┬───────┘               └──────────────┘
                                        │
                                 ┌──────▼───────┐
                                 │   Browser    │
                                 │  Visualizer  │
                                 └──────────────┘

Current Limitations

  • Local only — runs on localhost, no remote connections
  • Single connection — one Godot instance at a time
  • No undo — changes save directly (use version control)
  • AI is still limited in Godot knowledge — it can't create 100% of the game alone, but it can help debug, write scripts, and tag along for the journey

Development

To build from source instead of using npm:

cd mcp-server
npm install
npm run build

Then point your AI client at mcp-server/dist/index.js instead of using npx.


Release notes

Narrative write-ups of each release live in release-notes/ (starting with v0.5.0). For the full change history, see CHANGELOG.md.


License

MIT


npm package · Report Issues

About

MCP Server and Godot Plugin for AI-assisted game development

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors