Godot Script Integration

🚀 Godot MCP (Model Context Protocol)

A plugin for full integration between the Godot engine and AI assistants, using the Model Context Protocol (MCP). This plugin enables AI assistants to interact with your Godot projects, offering powerful code assistance, scene operation, and project management capabilities.

✨ Features

• Full Godot Project Access: AI assistants can access and modify scripts, scenes, nodes, and project resources.
• Two-Way Communication: Send project data to the AI and apply its suggested changes directly in the editor.
• Command Categories:
  • Node Commands: Create, modify, and manage nodes in the scene.
  • Script Commands: Edit, analyze, and create GDScript files.
  • Scene Commands: Operate on scenes and their structures.
  • Project Commands: Access project settings and resources.
  • Editor Commands: Control various editor functions.

🚀 Quick Start

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 the project root directory
cd ..

3. Set Up Claude Desktop

1. Edit or create the Claude Desktop configuration file:

   # For macOS
   nano ~/Library/Application\ Support/Claude/claude_desktop_config.json
   

2. Add the following configuration (or refer to the included claude_desktop_config.json as an example):

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

   ⚠️ Important Note: Replace PATH_TO_YOUR_PROJECT with the actual path where you stored this repository.

3. Restart Claude Desktop.

4. Open the Example Project in Godot

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

💻 Usage Examples

Creating a New Scene

1. Open Godot and load the project.
2. Right-click on the scene tree in the editor and select "Create New Scene".
3. Configure the scene settings and save.

Exporting the Project

# Run the following command in the terminal to export as HTML5
export_project ../export/html5/

📦 Resource Endpoints

📚 Documentation

Scene Commands

• scene/create: Create a new scene.
• scene/open: Open an existing scene.
• scene/save: Save the current scene.

Node Commands

• node/add: Add a node to the scene.
• node/remove: Delete a specified node.
• node/edit: Modify node properties.

🔧 Troubleshooting

The Plugin Isn't Working

• Reload the Godot project after any configuration changes.
• Check the error messages in the Godot console.
• Ensure that the paths in the Claude Desktop configuration are correct.

🛠️ Custom Project Integration

1. Copy the addons/godot_mcp folder to the addons directory of your Godot project.
2. Start the project, go to Project > Project Settings > Plugins, and enable "Godot MCP".

🤝 Contribution

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

📄 License

This project is licensed under the MIT License. Please refer to the LICENSE file for details.