Godot MCP

       A comprehensive Model Context Protocol (MCP) server for seamless AI assistant integration with the Godot game engine.

Table of Contents

- What is Godot MCP? - Features - Requirements - Installation - Configuration - API Reference - Project Architecture - Usage Examples - Read-Only Mode - Troubleshooting - FAQ - Contributing - License

What is Godot MCP?

Godot MCP bridges the gap between AI assistants and the Godot game engine by providing a standardized Model Context Protocol interface. This powerful integration enables AI assistants like Claude, Cursor, and Cline to directly interact with Godot projects through a comprehensive set of tools.

Key Value Propositions

- Direct Godot Integration: Launch editors, run projects, and capture debug output programmatically - Scene Management: Create, modify, and manage Godot scenes through AI commands - Real-time Feedback: AI assistants can see actual Godot output and errors for better assistance - Cross-platform Compatibility: Works seamlessly on Windows, macOS, and Linux - Secure Operations: Optional read-only mode for safe project analysis - Zero Configuration: Automatic Godot detection with manual override options

How It Works

The server acts as a middleware layer between your AI assistant and Godot, translating natural language commands into specific Godot operations. When you ask your AI to "create a player scene with a sprite," the MCP server: 1. Validates the request and project structure 2. Executes the appropriate Godot operations 3. Returns detailed success/error feedback 4. Enables the AI to understand and respond to the results This creates a powerful feedback loop where AI assistants can learn from actual Godot behavior, leading to more accurate code generation and debugging assistance.

Features

Core Project Management

- 🚀 Launch Godot Editor: Open the Godot editor for specific projects - ▶️ Run Godot Projects: Execute projects in debug mode with real-time output capture - 🛑 Control Execution: Start and stop Godot projects programmatically - 📊 Debug Output Capture: Retrieve comprehensive console output and error messages - ℹ️ System Information: Get installed Godot version and project metadata - 📁 Project Discovery: Find and list Godot projects in specified directories

Advanced Scene Management

- 🎬 Create New Scenes: Generate scenes with specified root node types - ➕ Add Nodes: Insert nodes into existing scenes with customizable properties - ✏️ Edit Node Properties: Modify positions, scales, textures, and other node attributes - 🗑️ Remove Nodes: Clean up scenes by removing unwanted nodes - 🖼️ Load Sprites: Automatically load textures into Sprite2D nodes - 🧱 Export MeshLibrary: Convert 3D scenes to MeshLibrary resources for GridMap - 💾 Save Scene Variants: Create scene copies and manage scene versions

Godot 4.4+ UID Management

- 🔗 Get File UIDs: Retrieve unique identifiers for project resources - 🔄 Update UID References: Maintain proper resource links during project upgrades

Security & Safety

- 🔒 Read-Only Mode: Restrict operations to analysis-only for secure environments - ✅ Path Validation: Comprehensive project and file path verification - 🛡️ Error Handling: Robust error reporting with actionable suggestions

Requirements

System Requirements

- Godot Engine: Version 3.5+ or 4.0+ (latest stable recommended) - Node.js & npm

AI Assistant Compatibility

- Cline & Roo Code: Full support with auto-approval configuration - Cursor & VS Code: Supports both UI and project-specific configuration - Claude Desktop: Compatible with MCP server integration - Other MCP-enabled tools: Any tool supporting the Model Context Protocol

Installation

Clone and Build

```bash