GO

Godot

Created 6 months ago

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

development documentation public Godot MCP

What is Godot?

A MCP server providing comprehensive Godot engine integration for project editing, debugging, and scene management.

Documentation

Godot MCP

Introduction

Godot MCP enables AI assistants to launch the Godot editor, run projects, capture debug output, and control project execution - all through a standardized interface.

Features

  • Launch Godot Editor: Open the Godot editor for a specific project
  • Run Godot Projects: Execute Godot projects in debug mode
  • Capture Debug Output: Retrieve console output and error messages
  • Control Execution: Start and stop Godot projects programmatically
  • Get Godot Version: Retrieve the installed Godot version
  • List Godot Projects: Find Godot projects in a specified directory
  • Project Analysis: Get detailed information about project structure
  • Scene Management: Create new scenes, add nodes, load sprites, export 3D scenes, save scenes
  • UID Management (for Godot 4.4+): Get and update UID references

Requirements

  • Godot Engine installed on your system
  • Node.js and npm
  • An AI assistant that supports MCP (Cline, Cursor, etc.)

Installation and Configuration# Step 1: Install and Build

git clone https://github.com/Coding-Solo/godot-mcp.git
cd godot-mcp
npm install
npm run build
```\n\n### Step 2: Configure with Your AI Assistant## Option A: Configure with Cline
Add to your Cline MCP settings file:
```json
{
  "mcpServers": {
    "godot": {
      "command": "node",
      "args": ["/absolute/path/to/godot-mcp/build/index.js"],
      "env": { "DEBUG": "true" },
      "disabled": false,
      "autoApprove": ["launch_editor", "run_project", "get_debug_output", "stop_project", "get_godot_version", "list_projects", "get_project_info", "create_scene", "add_node", "load_sprite", "export_mesh_library", "save_scene", "get_uid", "update_project_uids"]
    }
  }
}
```\n\n#### Option B: Configure with Cursor
Using the Cursor UI:
1. Go to **Cursor Settings** > **Features** > **MCP**
2. Click on the **+ Add New MCP Server** button
3. Fill out the form:
- Name: `godot`
- Type: `command`
- Command: `node /absolute/path/to/godot-mcp/build/index.js`
4. Click "Add"
5. Refresh the MCP server card

### Step 3: Optional Environment Variables
- `GODOT_PATH`: Path to the Godot executable
- `DEBUG`: Set to "true" to enable detailed logging

## Example Prompts
- "Launch the Godot editor for my project at /path/to/project"
- "Run my Godot project and show me any errors"

## Implementation Details# Architecture
The Godot MCP server uses a bundled GDScript approach for complex operations.

## Troubleshooting
- **Godot Not Found**: Set the GODOT_PATH environment variable
- **Connection Issues**: Ensure the server is running

## License
This project is licensed under the MIT License.

Server Config

{
  "mcpServers": {
    "godot-server": {
      "command": "npx",
      "args": [
        "godot"
      ]
    }
  }
}

Links & Status

Repository: github.com
Hosted: No
Global: No
Official: No

Project Info

Hosted Featured
Created At: May 23, 2025
Updated At: Aug 07, 2025
Author: Coding-Solo
Category: community
License: MIT License
Tags:
development documentation public