Skip to main content
Glama

Godot MCP

Fork von Coding-Solo/godot-mcp bei Commit 1209744 (MIT). Dieser Fork wird unabhängig von @jamesdowzard gepflegt und fügt Unterstützung für den Android-Export-Validator sowie weitere KI-freundliche Werkzeuge hinzu. Die Upstream-Fork-Beziehung ist auf Git-Ebene getrennt; Urheberrecht/Namensnennung gemäß MIT bleiben erhalten.

Made with Godot

                           (((((((             (((((((
                        (((((((((((           (((((((((((
                        (((((((((((((       (((((((((((((
                        (((((((((((((((((((((((((((((((((
                        (((((((((((((((((((((((((((((((((
         (((((      (((((((((((((((((((((((((((((((((((((((((      (((((
       (((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((
     ((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((
    ((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((
      (((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((
        (((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((
         (((((((((((@@@@@@@(((((((((((((((((((((((((((@@@@@@@(((((((((((
         (((((((((@@@@,,,,,@@@(((((((((((((((((((((@@@,,,,,@@@@(((((((((
         ((((((((@@@,,,,,,,,,@@(((((((@@@@@(((((((@@,,,,,,,,,@@@((((((((
         ((((((((@@@,,,,,,,,,@@(((((((@@@@@(((((((@@,,,,,,,,,@@@((((((((
         (((((((((@@@,,,,,,,@@((((((((@@@@@((((((((@@,,,,,,,@@@(((((((((
         ((((((((((((@@@@@@(((((((((((@@@@@(((((((((((@@@@@@((((((((((((
         (((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((
         (((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((
         @@@@@@@@@@@@@((((((((((((@@@@@@@@@@@@@((((((((((((@@@@@@@@@@@@@
         ((((((((( @@@(((((((((((@@(((((((((((@@(((((((((((@@@ (((((((((
         (((((((((( @@((((((((((@@@(((((((((((@@@((((((((((@@ ((((((((((
          (((((((((((@@@@@@@@@@@@@@(((((((((((@@@@@@@@@@@@@@(((((((((((
           (((((((((((((((((((((((((((((((((((((((((((((((((((((((((((
              (((((((((((((((((((((((((((((((((((((((((((((((((((((
                 (((((((((((((((((((((((((((((((((((((((((((((((
                        (((((((((((((((((((((((((((((((((


                          /$$      /$$  /$$$$$$  /$$$$$$$
                         | $$$    /$$$ /$$__  $$| $$__  $$
                         | $$$$  /$$$$| $$  \__/| $$  \ $$
                         | $$ $$/$$ $$| $$      | $$$$$$$/
                         | $$  $$$| $$| $$      | $$____/
                         | $$\  $ | $$| $$    $$| $$
                         | $$ \/  | $$|  $$$$$$/| $$
                         |__/     |__/ \______/ |__/

Ein Model Context Protocol (MCP)-Server für die Interaktion mit der Godot-Game-Engine.

Einführung

Godot MCP ermöglicht es KI-Agenten, den Godot-Editor zu starten, Projekte auszuführen, Debug-Ausgaben zu erfassen und die Projektausführung zu steuern. Diese direkte Feedbackschleife hilft Agenten zu verstehen, was in echten Godot-Projekten funktioniert und was nicht, was zu einer besseren Codegenerierung und Debugging-Unterstützung führt.

Related MCP server: Gear

Funktionen

  • Godot-Editor starten: Öffnen Sie den Godot-Editor für ein bestimmtes Projekt

  • Godot-Projekte ausführen: Führen Sie Godot-Projekte im Debug-Modus aus

  • Debug-Ausgabe erfassen: Konsolenausgaben und Fehlermeldungen abrufen

  • Ausführung steuern: Godot-Projekte programmgesteuert starten und stoppen

  • Godot-Version abrufen: Die installierte Godot-Version abrufen

  • Godot-Projekte auflisten: Godot-Projekte in einem angegebenen Verzeichnis finden

  • Projektanalyse: Detaillierte Informationen über die Projektstruktur erhalten

  • Szenenverwaltung:

    • Neue Szenen mit angegebenen Root-Knotentypen erstellen

    • Knoten zu bestehenden Szenen mit anpassbaren Eigenschaften hinzufügen

    • Sprites und Texturen in Sprite2D-Knoten laden

    • 3D-Szenen als MeshLibrary-Ressourcen für GridMap exportieren

    • Szenen mit Optionen zum Erstellen von Varianten speichern

  • UID-Verwaltung (für Godot 4.4+):

    • UID für bestimmte Dateien abrufen

    • UID-Referenzen durch erneutes Speichern von Ressourcen aktualisieren

Anforderungen

  • Godot Engine auf Ihrem System installiert

  • Node.js (>=18.0.0) und npm

  • Ein KI-Agent, der MCP unterstützt

Schnellstart

Claude Code

claude mcp add godot -- npx @coding-solo/godot-mcp

Das ist alles. Starten Sie Claude Code neu und Ihre Godot MCP-Tools sind verfügbar.

Mit Umgebungsvariablen:

claude mcp add godot -e GODOT_PATH=/path/to/godot -e DEBUG=true -- npx @coding-solo/godot-mcp

Fügen Sie dies zu Ihrer Cline MCP-Konfigurationsdatei hinzu (~/Library/Application Support/Code/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json):

{
  "mcpServers": {
    "godot": {
      "command": "npx",
      "args": ["@coding-solo/godot-mcp"],
      "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"
      ]
    }
  }
}

Verwendung der Cursor-Benutzeroberfläche:

  1. Gehen Sie zu Cursor Settings > Features > MCP

  2. Klicken Sie auf die Schaltfläche + Add New MCP Server

  3. Füllen Sie das Formular aus:

    • Name: godot

    • Type: command

    • Command: npx @coding-solo/godot-mcp

  4. Klicken Sie auf "Add"

  5. Möglicherweise müssen Sie die Aktualisierungsschaltfläche in der oberen rechten Ecke der MCP-Server-Karte drücken, um die Tool-Liste zu laden

Verwendung der projektspezifischen Konfiguration:

Erstellen Sie eine Datei unter .cursor/mcp.json in Ihrem Projektverzeichnis:

{
  "mcpServers": {
    "godot": {
      "command": "npx",
      "args": ["@coding-solo/godot-mcp"],
      "env": {
        "DEBUG": "true"
      }
    }
  }
}

Für jeden MCP-kompatiblen Client verwenden Sie diese Konfiguration:

{
  "mcpServers": {
    "godot": {
      "command": "npx",
      "args": ["@coding-solo/godot-mcp"],
      "env": {
        "GODOT_PATH": "/path/to/godot",
        "DEBUG": "true"
      }
    }
  }
}

Umgebungsvariablen

Variable

Beschreibung

GODOT_PATH

Pfad zur ausführbaren Godot-Datei (überschreibt die automatische Erkennung)

DEBUG

Auf "true" setzen, um detaillierte serverseitige Debug-Protokollierung zu aktivieren

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

Verweisen Sie dann Ihren MCP-Client auf build/index.js, anstatt npx zu verwenden.

Architektur

Der Godot MCP-Server verwendet einen gebündelten GDScript-Ansatz für komplexe Operationen:

  1. Direkte Befehle: Einfache Operationen wie das Starten des Editors oder das Abrufen von Projektinformationen verwenden direkt die integrierten CLI-Befehle von Godot.

  2. Gebündeltes Operationsskript: Komplexe Operationen wie das Erstellen von Szenen oder das Hinzufügen von Knoten verwenden eine einzige, umfassende GDScript-Datei (godot_operations.gd), die alle Operationen abwickelt.

Das gebündelte Skript akzeptiert den Operationstyp und die Parameter als JSON, was eine flexible und dynamische Ausführung von Operationen ermöglicht, ohne für jede Operation temporäre Dateien zu generieren.

Fehlerbehebung

  • Godot nicht gefunden: Setzen Sie die Umgebungsvariable GODOT_PATH auf den Pfad Ihrer ausführbaren Godot-Datei

  • Verbindungsprobleme: Stellen Sie sicher, dass der Server läuft, und starten Sie Ihren KI-Assistenten neu

  • Ungültiger Projektpfad: Stellen Sie sicher, dass der Pfad auf ein Verzeichnis zeigt, das eine project.godot-Datei enthält

  • Build-Probleme: Stellen Sie sicher, dass alle Abhängigkeiten durch Ausführen von npm install installiert wurden

  • Stellen Sie sicher, dass der MCP-Server in den Cursor-Einstellungen angezeigt und aktiviert ist (Settings > MCP)

  • MCP-Tools können nur mit dem Agent-Chat-Profil ausgeführt werden (Cursor Pro- oder Business-Abonnement)

  • Verwenden Sie den "Yolo Mode", um MCP-Tool-Anfragen automatisch auszuführen

Lizenz

Dieses Projekt ist unter der MIT-Lizenz lizenziert - siehe die Datei LICENSE für Details.

Available Tools

14 tools
add_nodeB

Add a node to an existing scene

Inputs: projectPath (required), scenePath (required), nodeType (required), nodeName (required), +2 more.

create_sceneA

Create a new Godot scene file

Inputs: projectPath (required), scenePath (required), rootNodeType.

export_mesh_libraryB

Export a scene as a MeshLibrary resource

Inputs: projectPath (required), scenePath (required), outputPath (required), meshItemNames.

get_debug_outputB

Get the current debug output and errors

Inputs: no named parameters.

get_godot_versionA

Get the installed Godot version

Inputs: no named parameters.

get_project_infoB

Retrieve metadata about a Godot project

Inputs: projectPath (required).

get_uidB

Get the UID for a specific file in a Godot project (for Godot 4.4+)

Inputs: projectPath (required), filePath (required).

launch_editorC

Launch Godot editor for a specific project

Inputs: projectPath (required).

list_projectsA

List Godot projects in a directory

Inputs: directory (required), recursive.

load_spriteC

Load a sprite into a Sprite2D node

Inputs: projectPath (required), scenePath (required), nodePath (required), texturePath (required).

run_projectC

Run the Godot project and capture output

Inputs: projectPath (required), scene.

save_sceneC

Save changes to a scene file

Inputs: projectPath (required), scenePath (required), newPath.

stop_projectA

Stop the currently running Godot project

Inputs: no named parameters.

update_project_uidsB

Update UID references in a Godot project by resaving resources (for Godot 4.4+)

Inputs: projectPath (required).

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

    TDQS

    B3.4/5.0

    Scored across 14 tools

    Disambiguation4/5

    Most tools have distinct purposes targeting different aspects of Godot project management, scene manipulation, and debugging. However, there is some potential overlap between 'create_scene' and 'add_node' as both involve scene creation/modification, and 'get_debug_output' and 'run_project' both relate to runtime output, though their specific focuses differ enough to avoid major confusion.

    Naming Consistency4/5

    The naming follows a consistent verb_noun pattern throughout (e.g., 'add_node', 'create_scene', 'get_debug_output'), which is clear and predictable. There are minor deviations like 'export_mesh_library' using a compound noun and 'update_project_uids' being slightly longer, but overall the convention is well-maintained and readable.

    Tool Count5/5

    With 14 tools, the count is well-scoped for a Godot MCP server, covering project management, scene editing, debugging, and runtime operations. Each tool appears to earn its place by addressing specific needs in the Godot development workflow, without being overly sparse or bloated.

    Completeness4/5

    The tool set provides comprehensive coverage for core Godot operations, including project listing, scene CRUD, debugging, and runtime management. Minor gaps exist, such as the lack of tools for editing node properties directly or handling more advanced resource types, but agents can likely work around these with the available tools for most common tasks.

    Maintenance

    ActivityNo data
    ResponsivenessSyncing

    Related MCP Connectors

    Related MCP Servers

    • A
      license
      A
      quality
      D
      maintenance
      An MCP server that gives AI assistants direct control over Godot 4 game development projects. It enables launching the editor, running projects, creating and editing scenes, writing GDScript, and inspecting assets through natural language commands.
      44
      12 npm
      4
      MIT
    • A
      license
      A
      quality
      D
      maintenance
      An MCP server that enables AI assistants to directly run, inspect, modify, and debug Godot game development projects through 110+ tools covering scenes, scripts, resources, runtime debugging, and asset management.
      33
      21 npm
      3
      MIT
    • A
      license
      B
      quality
      D
      maintenance
      An enhanced MCP server for interacting with the Godot game engine, enabling AI assistants to launch the editor, run projects, manage scenes and nodes, and handle scripts.
      16
      MIT
    • A
      license
      A
      quality
      C
      maintenance
      An MCP server that lets AI coding agents work on Godot 4 projects, including reading and editing scenes, writing and validating GDScript, running the game, and capturing screenshots.
      25
      24 npm
      MIT