Installation
Prerequisites
This plugin needs uv
installed on your machine.
To check if it is installed open Command Prompt
(on Windows) or Terminal
(on macOS) and run the command uv --version
If you get a valid output with the version, you’re all set. Otherise install it by following the guide here :
The are 2 main steps in installing this plugin:
- Install in your Godot project
- Install in your MCP Client eg. Cursor, Windsurf, VSCode, etc
1. Install in Godot project
This is a normal plugin for Godot. To install it follow these steps:
-
Close the Godot Editor.
-
Download the latest version of the plugin (zip file) and extract it. You will get an
addons
folder and inside that there will begdai-mcp-plugin-godot
folder. -
Copy the
addons/gdai-mcp-plugin-godot/
from the extracted zip tores://addons/
of your Godot project. -
Now open the project in Godot editor, and the plugin is installed. (You don’t need to enable the plugin in Project Settings)
-
You should see a
GDAI MCP
tab in the bottom panel of the Editor. -
In the
GDAI MCP
tab, you can:- Start/Stop the MCP server
- Check for plugin updates
- Find quick links to the Plugin Website, and Docs.
- The JSON config which you will need to setup the server in a MCP Client is also shown. Copy the JSON for later use.
-
Now you can proceed to install the MCP server in your MCP client.
Recommended Godot Editor Settings
-
In Godot Editor Settings, make sure to enable the
Auto Reload Scripts on External Change
andAuto Reload and Parse Scripts on Save
options. If you don’t see this options, make sure to enableAdvanced Settings
in the top right.
2. Install in MCP Client
Installation may be slightly different based on which MCP Client you are using. Installation steps for some of the popular MCP Clients is given below:
Claude Desktop
For installing in Claude Desktop:
-
Open Claude Desktop, and goto the Settings.
-
Then click on
Developer
, and then click onEdit Config
. Then also close Claude Desktop app. -
If you don’t have any MCP servers setup before, you will see the below JSON file.
{ "mcpServers": {} }
-
Update the JSON file as follows (What you copied earlier from the
GDAI MCP
tab in Godot):{ "mcpServers": { "godot-mcp": { "command": "uv", "args": ["run", "/absolute/path/to/addons/gdai-mcp-plugin-godot/gdai_mcp_server.py"] } } }
You can name
godot-mcp
to whatever you want likemy-awesome-game-godot-mcp
. -
Now open Claude Desktop, and you should see the MCP server as shown in the screenshot below:
-
You can now chat and start letting AI automate your Godot workflows.
Cursor
-
Open Cursor, and goto Cursor Settings.
-
Then click the
MCP
tab, and then clickAdd new global MCP server
. -
Now in the text editor that opens, paste the same JSON config which you got from the
GDAI MCP
tab in Godot. -
You should then see the server in Cursor.
-
You can now chat and start letting AI automate your Godot workflows.
Windsurf
-
Open Windsurf, and goto the
Cascade
section. -
Then click the small Hammer icon (1) and then click the Configure button (2) as shown in the screenshot below:
-
Now in the text editor that opens, paste the same JSON config which you got from the
GDAI MCP
tab in Godot. -
You should then see the server in Windsurf.
-
You can now chat and start letting AI automate your Godot workflows.
VS Code Copilot
-
Open your project in VS Code
-
Create a folder
.vscode
if it doesnt exist at the project root. -
Create a file
mcp.json
inside the.vscode
folder. -
In the
mcp.json
file paste the same JSON config which you got from the GDAI MCP tab in Godot. Make sure to replace the wordmcpServers
with justservers
. See the below image. -
Restart VSCode, and you should see the GDAI MCP server, in the MCP servers list by clicking the wrench icon in the bottom chat area.
-
You can now chat and start letting AI automate your Godot workflows.
3. Try it out
Once you have installed both in Godot and in your MCP client. Make sure that your project is open in the Godot Editor. Then you start chatting about your project and ask the AI to work on the project.
Next steps: