Skip to Content
DocsInstallation

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:

Terminal uv version


The are 2 main steps in installing this plugin:

  1. Install in your Godot project
  2. 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:

  1. Close the Godot Editor.

  2. Download the latest version of the plugin (zip file) and extract it. You will get an addons folder and inside that there will be gdai-mcp-plugin-godot folder. Folder after extracting the plugin

  3. Copy the addons/gdai-mcp-plugin-godot/ from the extracted zip to res://addons/ of your Godot project. Project after copying the plugin

  4. Now open the project in Godot editor, and the plugin is installed. (You don’t need to enable the plugin in Project Settings)

  5. You should see a GDAI MCP tab in the bottom panel of the Editor. GDAI MCP bottom tab

  6. 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. Command to use in MCP client
  7. Now you can proceed to install the MCP server in your MCP client.

  • In Godot Editor Settings, make sure to enable the Auto Reload Scripts on External Change and Auto Reload and Parse Scripts on Save options. If you don’t see this options, make sure to enable Advanced Settings in the top right.

    External Script Changes settings

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:

  1. Open Claude Desktop, and goto the Settings. Open Settings in Claude Desktop

  2. Then click on Developer, and then click on Edit Config. Then also close Claude Desktop app. Navigate to Edit Config in Developer settings

  3. If you don’t have any MCP servers setup before, you will see the below JSON file.

    { "mcpServers": {} }
  4. 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 like my-awesome-game-godot-mcp.

  5. Now open Claude Desktop, and you should see the MCP server as shown in the screenshot below: MCP Server in Claude Desktop chat

  6. You can now chat and start letting AI automate your Godot workflows.

Cursor

  1. Open Cursor, and goto Cursor Settings. Goto Cursor Settings

  2. Then click the MCP tab, and then click Add new global MCP server. Click add new MCP server

  3. Now in the text editor that opens, paste the same JSON config which you got from the GDAI MCP tab in Godot. Cursor MCP server config

  4. You should then see the server in Cursor. MCP Server is installed in Cursor

  5. You can now chat and start letting AI automate your Godot workflows.

Windsurf

  1. Open Windsurf, and goto the Cascade section.

  2. Then click the small Hammer icon (1) and then click the Configure button (2) as shown in the screenshot below: MCP Server setting in Windsurf IDE

  3. Now in the text editor that opens, paste the same JSON config which you got from the GDAI MCP tab in Godot. Windsurf MCP server config

  4. You should then see the server in Windsurf. MCP Server is installed in Windsurf IDE

  5. You can now chat and start letting AI automate your Godot workflows.

VS Code Copilot

  1. Open your project in VS Code

  2. Create a folder .vscode if it doesnt exist at the project root.

  3. Create a file mcp.json inside the .vscode folder. VS Code create mcp json

  4. 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 word mcpServers with just servers. See the below image. VS Code mcp.json view

  5. 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. VS Code see GDAI MCP server

  6. 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:

Last updated on