Godot-MCP

MCP.Pizza Chef: ee0pdt

Godot MCP is a server integration that connects the Godot game engine with AI assistants via the Model Context Protocol. It provides AI models full access to Godot projects, enabling script editing, scene and node manipulation, and project management directly through AI commands. This facilitates seamless two-way communication between the AI and the Godot editor, empowering developers to automate and enhance game development workflows.

Use This MCP server To

Edit and create GDScript files using AI suggestions Manipulate scene nodes and structure programmatically Manage project settings and resources via AI commands Automate repetitive game development tasks in Godot Integrate AI-driven code analysis and debugging Control Godot editor functions through natural language Generate and modify game scenes with AI assistance

README

Godot MCP (Model Context Protocol)

A comprehensive integration between Godot Engine and AI assistants using the Model Context Protocol (MCP). This plugin allows AI assistants to interact with your Godot projects, providing powerful capabilities for code assistance, scene manipulation, and project management.

Features

  • Full Godot Project Access: AI assistants can access and modify scripts, scenes, nodes, and project resources
  • Two-way Communication: Send project data to AI and apply suggested changes directly in the editor
  • Command Categories:
    • Node Commands: Create, modify, and manage nodes in your scenes
    • Script Commands: Edit, analyze, and create GDScript files
    • Scene Commands: Manipulate scenes and their structure
    • Project Commands: Access project settings and resources
    • Editor Commands: Control various editor functionality

Quick Setup

1. Clone the Repository

git clone https://github.com/ee0pdt/godot-mcp.git
cd godot-mcp

2. Set Up the MCP Server

cd server
npm install
npm run build
# Return to project root
cd ..

3. Set Up Claude Desktop

  1. Edit or create the Claude Desktop config file:

    # For macOS
    nano ~/Library/Application\ Support/Claude/claude_desktop_config.json
  2. Add the following configuration (or use the included claude_desktop_config.json as a reference):

    {
      "mcpServers": {
        "godot-mcp": {
     	 "command": "node",
     	 "args": [
     	   "PATH_TO_YOUR_PROJECT/server/dist/index.js"
     	 ],
     	 "env": {
     	   "MCP_TRANSPORT": "stdio"
     	 }
        }
      }
    }

    Note: Replace PATH_TO_YOUR_PROJECT with the absolute path to where you have this repository stored.

  3. Restart Claude Desktop

4. Open the Example Project in Godot

  1. Open Godot Engine
  2. Select "Import" and navigate to the cloned repository
  3. Open the project.godot file
  4. The MCP plugin is already enabled in this example project

Using MCP with Claude

After setup, you can work with your Godot project directly from Claude using natural language. Here are some examples:

Example Prompts

@mcp godot-mcp read godot://script/current

I need help optimizing my player movement code. Can you suggest improvements?
@mcp godot-mcp run get-scene-tree

Add a cube in the middle of the scene and then make a camera that is looking at the cube.
@mcp godot-mcp read godot://scene/current

Create an enemy AI that patrols between waypoints and attacks the player when in range.

Natural Language Tasks Claude Can Perform

  • "Create a main menu with play, options, and quit buttons"
  • "Add collision detection to the player character"
  • "Implement a day/night cycle system"
  • "Refactor this code to use signals instead of direct references"
  • "Debug why my player character falls through the floor sometimes"

Available Resources and Commands

Resource Endpoints:

  • godot://script/current - The currently open script
  • godot://scene/current - The currently open scene
  • godot://project/info - Project metadata and settings

Command Categories:

Node Commands

  • get-scene-tree - Returns the scene tree structure
  • get-node-properties - Gets properties of a specific node
  • create-node - Creates a new node
  • delete-node - Deletes a node
  • modify-node - Updates node properties

Script Commands

  • list-project-scripts - Lists all scripts in the project
  • read-script - Reads a specific script
  • modify-script - Updates script content
  • create-script - Creates a new script
  • analyze-script - Provides analysis of a script

Scene Commands

  • list-project-scenes - Lists all scenes in the project
  • read-scene - Reads scene structure
  • create-scene - Creates a new scene
  • save-scene - Saves current scene

Project Commands

  • get-project-settings - Gets project settings
  • list-project-resources - Lists project resources

Editor Commands

  • get-editor-state - Gets current editor state
  • run-project - Runs the project
  • stop-project - Stops the running project

Troubleshooting

Connection Issues

  • Ensure the plugin is enabled in Godot's Project Settings
  • Check the Godot console for any error messages
  • Verify the server is running when Claude Desktop launches it

Plugin Not Working

  • Reload Godot project after any configuration changes
  • Check for error messages in the Godot console
  • Make sure all paths in your Claude Desktop config are absolute and correct

Adding the Plugin to Your Own Godot Project

If you want to use the MCP plugin in your own Godot project:

  1. Copy the addons/godot_mcp folder to your Godot project's addons directory
  2. Open your project in Godot
  3. Go to Project > Project Settings > Plugins
  4. Enable the "Godot MCP" plugin

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Documentation

For more detailed information, check the documentation in the docs folder:

License

This project is licensed under the MIT License - see the LICENSE file for details.

Godot-MCP FAQ

How does Godot MCP integrate with the Godot Engine?
It acts as a server exposing Godot project data and editor controls to AI assistants via MCP, enabling two-way interaction.
Can Godot MCP modify game scripts directly?
Yes, it allows AI assistants to edit, analyze, and create GDScript files within the project.
What types of project elements can AI control through Godot MCP?
AI can manage nodes, scenes, scripts, project settings, and editor functions.
Is it possible to automate scene creation with Godot MCP?
Yes, AI can create and modify scenes and their node structures programmatically.
How do I set up Godot MCP in my project?
Clone the GitHub repository and follow the setup instructions to integrate the MCP server plugin into Godot.
Does Godot MCP support real-time updates between AI and the editor?
Yes, it supports two-way communication allowing immediate application of AI-suggested changes.
Can I use Godot MCP with different AI providers?
Yes, it is provider-agnostic and works with models like Claude, GPT-4, and Gemini.
What editor functionalities can be controlled via Godot MCP?
Various editor commands including project management, scene navigation, and resource handling are supported.