This project provides a Model Context Protocol (MCP) server designed to bridge the gap between AI assistants and the Godot game engine. It enables AI agents to programmatically launch the Godot editor, run projects, capture debug output, and manipulate project assets, facilitating AI-driven game development and debugging.

How It Works

The MCP server leverages a hybrid approach for interacting with Godot. Simple commands like launching the editor or retrieving the Godot version are executed via Godot's command-line interface. For more complex operations such as scene creation, node manipulation, or asset loading, the server utilizes a single, bundled GDScript file (godot_operations.gd). This script receives operation details and parameters as JSON, allowing for dynamic execution without the need for temporary files, thereby reducing overhead and simplifying maintenance.

Quick Start & Requirements

• Install/Run:

  git clone https://github.com/Coding-Solo/godot-mcp.git
  cd godot-mcp
  npm install
  npm run build
  

  Then configure your AI assistant (Cline, Cursor) with the path to the built index.js.
• Prerequisites: Godot Engine installed, Node.js and npm.
• Configuration: Requires integration into AI assistant settings (e.g., cline_mcp_settings.json or Cursor's MCP settings).
• Links: Project Repository

Highlighted Details

• Enables AI assistants to directly interact with Godot projects for code generation and debugging.
• Supports a wide range of operations including scene management, asset loading, and project analysis.
• Uses a bundled GDScript for complex operations, avoiding temporary files.
• Offers configuration options for both Cline and Cursor AI assistants.

Maintenance & Community

The project appears to be maintained by Coding-Solo. Further community or maintenance details are not explicitly provided in the README.

Licensing & Compatibility

• License: MIT License.
• Compatibility: Permissive license suitable for commercial use and integration with closed-source projects.

Limitations & Caveats

The README notes that MCP tools in Cursor require a Pro or Business subscription and may only be usable via the "Agent chat profile." Some features, like UID management, are specific to Godot 4.4+.