gdai -plugin-godot

The GDAI MCP Godot Plugin provides an interface for AI agents and MCP clients to control and automate the Godot Editor. Through the MCP server, you can issue commands to create scenes, nodes, resources, and scripts, inspect and debug GDScript, and capture logs and debugger output from a running Godot project. The plugin is designed to work with any MCP client (Cursor, Windsurf, VS Code-based clients, Claude Desktop, etc.), enabling remote interaction with Godot projects via natural language prompts or scripted prompts.

To use it, install the plugin in your Godot project and configure your MCP client with the server command. Start the MCP server on your preferred host, then connect your MCP client and begin issuing commands such as creating a scene, adding nodes, updating properties, or querying for script errors. The system also supports newer capabilities like automatic screenshot capture to visualize the editor and running game state, aiding debugging and rapid iteration.

Prerequisites:

• Node.js installed on the host machine (for using npx to fetch the package) or access to an environment where npm/npx is available.
• Access to the internet to fetch the gdai-mcp-plugin-godot package from npm registry.

Step-by-step:

1. Prepare your environment:

   • Ensure Node.js and npm are installed: node -v and npm -v
   • If you plan to run via MCP client on a server, ensure network access to npm registry.

2. Install the MCP server package (example with npx):

   • You can run the MCP server directly via npx without a global install: npx -y gdai-mcp-plugin-godot

3. Configure your MCP client:

   • Add the server command and arguments to your MCP client config. Example: command: npx args: [-y, gdai-mcp-plugin-godot]

4. Integrate with Godot:

   • In Godot, install the GDAI MCP Plugin into your project following the installation guide provided by the project (link in the README).
   • Ensure the Godot project is accessible to the MCP server and the client can reach it over the network if running remotely.

5. Run and test:

   • Start the MCP server with the configured command.
   • Connect using your MCP client and issue a basic command to verify connectivity (e.g., create a scene or inspect logs).

Notes:

• If you prefer a containerized or dedicated environment, consider wrapping the npm package in a docker run command once you have the image ready.
• Adjust environment variables as needed for logging or runtime behavior.

Tips and common considerations:

• npm_package is gdai-mcp-plugin-godot, so using npx will fetch the latest release; pin versions if you need reproducible behavior.
• You can enable verbose logs via environment variables (if supported by the plugin) to help diagnose issues with Godot integration or MCP client interactions.
• Ensure the Godot Editor version is compatible (Godot 4.1+ is indicated in/readme) to match plugin support.
• When running in CI or server environments, consider network latency between the MCP server and the Godot editor to avoid command timeouts.
• If you encounter permissions issues, run with appropriate user privileges or adjust container/file permissions where the Godot project resides.