mcp_godot

# MCP Godot MCP Godot is an integration of the Model Context Protocol (MCP) implemented for the Godot game engine. It allows AI assistants (such as Claude, Windsurf, and Cursor) to interact with the Godot editor and perform various operations. This implementation is minimal, stable, and reliable, supporting a complete game development workflow. ## Features MCP Godot provides the following core functionalities: ### Scene Operations - `create_scene`: Create a new scene (supports 2D and 3D templates) - `open_scene`: Open an existing scene - `save_scene`: Save the current scene - `close_scene`: Close the current scene ### Node Operations - `add_node`: Add a new node to the scene - `remove_node`: Remove a node from the scene - `select_node`: Select a node in the scene tree - `duplicate_node`: Duplicate an existing node ### Property Operations - `set_property`: Set the property value of a node - `get_property`: Get the property value of a node ### Script Operations - `create_script`: Create a new script - `attach_script`: Attach a script to a node - `edit_script`: Edit an existing script ### Notification Operations - `notify`: Display a notification message in the Godot editor ## Requirements - Godot 4.4 or higher - Node.js 18 or higher - npm 9 or higher ## Installation ### Step 1: Install the Godot Plugin 1. Copy the `godot_plugin` directory to the `addons` directory of your Godot project and rename it to `mcp_godot` 2. In the Godot editor, go to `Project > Project Settings > Plugins` 3. Find the "MCP Godot" plugin and enable it ### Step 2: Install the Node.js MCP Server 1. Ensure that Node.js and npm are installed 2. Navigate to the `server` directory 3. Run `npm install` to install dependencies 4. Run `npm run build` to build the server ## Usage ### Start the MCP Server 1. Ensure that the Godot editor is open and the MCP Godot plugin is enabled 2. In the `server` directory, run `npm start` to start the MCP server ### Configure AI Assistants Configure the MCP server connection according to the AI assistant you are using (such as Windsurf, Cursor, etc.) by following the respective instructions. ## Troubleshooting ### WebSocket Connection Issues - Ensure that the Godot editor is open and the MCP Godot plugin is enabled - Confirm that port 8090 is not occupied by other applications - Check firewall settings to allow local WebSocket connections ### Command Execution Failures - Ensure that the command you are trying to execute is available in the current Godot context - Check that the node path is correct (case-sensitive) ## Development ### Extending Tools To add new tools, create a new file in the `server/src/tools` directory and register it in `server/src/index.ts`. ### Extending Resources To add new resources, create a new file in the `server/src/resources` directory and register it in `server/src/index.ts`. ## License MIT