How do I install Godot MCP?

Copy the stdio config for Cursor, Claude Desktop, Claude Code, or VS Code on this page. It uses the publisher's install, not a PlugMCP proxy.

Does Godot MCP need an API key?

The publisher lists these environment variables: GODOT_PROJECT_PATH, GODOT_PATH, GODOT_MCP_MODE, GODOT_MCP_TOOLSETS, GODOT_MCP_READ_ONLY, GODOT_MCP_ALLOW_EVAL, GODOT_MCP_CONFIRM, GODOT_MCP_LOG_LEVEL, GODOT_MCP_HEADLESS_TIMEOUT_MS, GODOT_MCP_BRIDGE_TIMEOUT_MS, GODOT_MCP_LSP_PORT, GODOT_MCP_LSP_TIMEOUT_MS, GODOT_MCP_LSP_IDLE_MS, GODOT_MCP_CACHE_DIR.

What transport does Godot MCP use?

Godot MCP runs locally over stdio.

When was Godot MCP last checked?

Last checked 2026-11-10. Edit Godot 4 scenes, nodes and scripts; run, test and debug games live in the editor or headless.

Godot MCP server

Power your agent

Add this server

The publisher's own command. Not a PlugMCP endpoint.

Add to Cursor Add to VS Code Run on PlugMCP

Host a copy with our keys and logs.

Local command

npx -y @shin2344234/[email protected]

Credentials from the publisher

GODOT_PROJECT_PATH — Folder of the Godot project (the one containing project.godot). Defaults to the folder the client starts the server in, so set it whenever that is not your project (e.g. in desktop apps).
GODOT_PATH — Full path of the Godot 4.x executable (GODOT_BIN is accepted too). If unset, the server looks for godot, godot4 or Godot_v4* on PATH. On Windows use the main Godot exe, not the _console.exe launcher.
GODOT_MCP_MODE — How tools are exposed: 'full' lists every enabled operation as its own tool (best for clients with tool search); 'compact' lists only core tools plus router tools that reach the rest.
GODOT_MCP_TOOLSETS — Comma-separated tool groups to enable, or 'all' (default). Groups: core, files, scene, node, script, run, editor, signal, resource, visual, anim, world, audio, project, import, export, code, docs, game, debug, test. 'core' is always on.
GODOT_MCP_READ_ONLY — Set to true to hide every tool that changes something (inspection only).
GODOT_MCP_ALLOW_EVAL — Set to true to let godot_game_eval run GDScript inside the running game. Off by default: evaluated code can do anything the game can (files, OS calls).
GODOT_MCP_CONFIRM — 'elicit' asks the user (through the client's elicitation dialog, when supported) before irreversible operations; 'never' skips asking, for unattended runs where nobody can answer.
GODOT_MCP_LOG_LEVEL — Verbosity of the server's stderr log (use 'debug' when filing a bug report).
GODOT_MCP_HEADLESS_TIMEOUT_MS — Advanced: timeout for one headless Godot invocation, in milliseconds.
GODOT_MCP_BRIDGE_TIMEOUT_MS — Advanced: timeout for one request to the live editor bridge, in milliseconds.
GODOT_MCP_LSP_PORT — Advanced: port of the Godot editor's GDScript language server on 127.0.0.1. Defaults to the port the editor plugin reports, else 6005.
GODOT_MCP_LSP_TIMEOUT_MS — Advanced: timeout for one GDScript language server request, in milliseconds.
GODOT_MCP_LSP_IDLE_MS — Advanced: stop the private headless language server after this many milliseconds without code tool calls.
GODOT_MCP_CACHE_DIR — Advanced: folder for the server's cache (the Godot class docs index). Defaults to the per-user cache folder of the OS.

Claude Code has no install link for a local command. Copy the command below and run it in a terminal.

shClaude Code

1GODOT_PROJECT_PATH=<value> GODOT_PATH=<value> GODOT_MCP_MODE=<value> GODOT_MCP_TOOLSETS=<value> GODOT_MCP_READ_ONLY=<value> GODOT_MCP_ALLOW_EVAL=<value> GODOT_MCP_CONFIRM=<value> GODOT_MCP_LOG_LEVEL=<value> GODOT_MCP_HEADLESS_TIMEOUT_MS=<value> GODOT_MCP_BRIDGE_TIMEOUT_MS=<value> GODOT_MCP_LSP_PORT=<value> GODOT_MCP_LSP_TIMEOUT_MS=<value> GODOT_MCP_LSP_IDLE_MS=<value> GODOT_MCP_CACHE_DIR=<value> claude mcp add io.github.shin2344234-godot-mcp -- npx -y @shin2344234/godot-mcp@0.1.2

Run in a terminal.

jsonClaude Desktop

1{2  "mcpServers": {3    "io.github.shin2344234-godot-mcp": {4      "command": "npx",5      "args": [6        "-y",7        "@shin2344234/[email protected]"8      ],9      "env": {10        "GODOT_PROJECT_PATH": "<value>",11        "GODOT_PATH": "<value>",12        "GODOT_MCP_MODE": "<value>",13        "GODOT_MCP_TOOLSETS": "<value>",14        "GODOT_MCP_READ_ONLY": "<value>",15        "GODOT_MCP_ALLOW_EVAL": "<value>",16        "GODOT_MCP_CONFIRM": "<value>",17        "GODOT_MCP_LOG_LEVEL": "<value>",18        "GODOT_MCP_HEADLESS_TIMEOUT_MS": "<value>",19        "GODOT_MCP_BRIDGE_TIMEOUT_MS": "<value>",20        "GODOT_MCP_LSP_PORT": "<value>",21        "GODOT_MCP_LSP_TIMEOUT_MS": "<value>",22        "GODOT_MCP_LSP_IDLE_MS": "<value>",23        "GODOT_MCP_CACHE_DIR": "<value>"24      }25    }26  }27}

claude_desktop_config.json

Local · npmPublisher installStep-by-step: add this in Claude

Remote URL or a command on your machine? How the two installs differ

Run on PlugMCP

Host a copy with our keys and logs.

A new server you create. It is not this listing's official endpoint. Use the publisher install when you want their URL and their credentials.

Launch

Tools

No tool list yet. Remote servers get one after the first health check.

FAQ

Questions

godot-mcp

An MCP server for the Godot 4 engine. It lets AI agents such as Claude Code, Claude Desktop, Cursor, VS Code Copilot, Codex, Gemini CLI, Windsurf and Zed work on your Godot project:

inspect and edit scenes, nodes, signals and resources

author animations, AnimationTrees, SpriteFrames, tile maps, navigation, audio buses and visual shaders

change project settings, input actions, autoloads, import options and export presets, and run exports

write scripts with GDScript language-server diagnostics, symbols and renames

look up the Godot class reference offline for the exact version you have installed

run the game and work on it live: inspect and change nodes, send input, pause and step frames, take screenshots, profile, record and replay input

debug with breakpoints, stepping, stack and variables, and run GUT or GdUnit4 tests

It works through a live editor bridge, so every scene edit can be undone with Ctrl+Z, and through headless Godot when the editor is closed.

Requirements

Godot 4.7 or newer (tested with 4.7.2)

Node.js 22 or newer, unless you use the Claude Desktop bundle, which brings its own

Install

In your Godot project folder (the one with project.godot), run:

npx -y @shin2344234/godot-mcp init

init shows its plan and asks before writing anything (--dry-run previews, --remove undoes). It copies the editor addon into addons/godot_mcp and enables it, registers the server with the agents it finds on your machine (or the ones you pick with --agents claude-code,cursor,vscode,codex,gemini-cli,...), and adds a short note to AGENTS.md.

Then open the project in Godot, start a new agent session and ask it to call godot_status to check the connection.

Other ways to install

Claude Code plugin: run /plugin marketplace add shin2344234/godot-mcp, then /plugin install godot-mcp@godot-mcp.

Claude Desktop: download the .mcpb file from Releases and double-click it.

Any other MCP client: add the server to its config by hand. docs/setup.md gives the exact file and format for each client.

From source:

git clone https://github.com/shin2344234/godot-mcp
cd godot-mcp/server && npm install && npm run build
cd /path/to/my-game
node /path/to/godot-mcp/server/dist/index.js init

If you installed without init, ask the agent to run godot_addon_install once per project to add the editor addon.

Documentation

Setup for each client: Claude Code, Claude Desktop, Cursor, VS Code, Codex, Gemini CLI, Windsurf and Zed, all options, and Windows notes

Tools: every tool by group, tool modes and toolsets, resources and prompts

How it works: editor bridge, headless fallback, the in-game runtime, safety and context size

Troubleshooting: error messages and fixes

All documentation, including the per-area method references and protocol designs

Changelog · Contributing · Security

License

Add this server

Host a copy with our keys and logs.

Tools

Questions

Server facts

How do I install Godot MCP?

Does Godot MCP need an API key?

What transport does Godot MCP use?

When was Godot MCP last checked?

Documentation

godot-mcp

Requirements

Install

Other ways to install

Documentation

License