Godot MCP - Overview

Title

Godot MCP – A Model Context Protocol (MCP) server for interacting with the Godot game engine.

How to Use

Godot MCP allows AI assistants to control Godot projects, capture debug output, and manage scenes programmatically.

Installation & Setup

1. Clone & Build:

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

2. Configure with AI Assistant:
   • For Cline: Modify cline_mcp_settings.json to include the MCP server.
   • For Cursor: Use the UI or create .cursor/mcp.json in your project.
3. Optional Environment Variables:
   • GODOT_PATH: Manually set Godot executable path.
   • DEBUG: Enable detailed logging.

Key Features

• Godot Project Control:
  • Launch the Godot editor.
  • Run projects in debug mode.
  • Capture console output and errors.
  • Stop execution programmatically.
• Project Analysis:
  • List projects in a directory.
  • Retrieve project structure details.
• Scene & Asset Management:
  • Create and modify scenes.
  • Add nodes with custom properties.
  • Load sprites and textures.
  • Export 3D scenes as MeshLibrary.
• UID Management (Godot 4.4+):
  • Get and update UID references.

Use Cases

• AI-Assisted Development:
  • Helps AI assistants like Claude test and debug Godot projects in real time.
• Automated Workflows:
  • Run projects, capture logs, and analyze errors without manual intervention.
• Scene & Resource Management:
  • Automate scene creation, node addition, and asset loading.
• Project Analysis:
  • Quickly inspect project structure for debugging or documentation.

Godot MCP bridges AI and Godot development, enabling smoother workflows and better debugging assistance. 🚀