A Model Context Protocol (MCP) server for interacting with the Godot game engine.
Godot MCP enables AI agents to launch the Godot editor, run projects, capture debug output, and control project execution. This direct feedback loop helps agents understand what works and what doesn't in real Godot projects, leading to better code generation and debugging assistance.
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 with specified root node types
- Add nodes to existing scenes with customizable properties
- Load sprites and textures into Sprite2D nodes
- Export 3D scenes as MeshLibrary resources for GridMap
- Save scenes with options for creating variants
UID Management(for Godot 4.4+)
-
Get UID for specific files
-
Update UID references by resaving resources
-
Godot Engine installed on your system
-
Node.js (>=18.0.0) and npm
-
An AI agent that supports MCP
claude mcp add godot -- npx @coding-solo/godot-mcp
That's it. Restart Claude Code and your Godot MCP tools are available.
With environment variables:
claude mcp add godot -e GODOT_PATH=/path/to/godot -e DEBUG=true -- npx @coding-solo/godot-mcp
Cline
Add to your Cline MCP settings file (~/Library/Application Support/Code/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json):
{
"mcpServers": {
"godot": {
...
Cursor
Using the Cursor UI:
-
Go to
Cursor Settings>Features>MCP - Click on the
+ Add New MCP Serverbutton - Fill out the form:
-
Name:
godot
-
Type:
command
-
Command:
npx @coding-solo/godot-mcp
-
Name:
-
Click "Add"
-
You may need to press the refresh button in the top right corner of the MCP server card to populate the tool list
Using Project-Specific Configuration:
Create a file at .cursor/mcp.json
in your project directory:
{
"mcpServers": {
"godot": {
...
Other MCP Clients
For any MCP-compatible client, use this configuration:
{
"mcpServers": {
"godot": {
...
| Variable | Description |
|---|
GODOT_PATH | |
| Path to the Godot executable (overrides automatic detection) | |
DEBUG | |
Set to "true" to enable detailed server-side debug logging | |
Building from Source
git clone https://github.com/Coding-Solo/godot-mcp.git
cd godot-mcp
npm install
...
Then point your MCP client to build/index.js
instead of using npx.
The Godot MCP server uses a bundled GDScript approach for complex operations:
Direct Commands: Simple operations like launching the editor or getting project info use Godot's built-in CLI commands directly.
Bundled Operations Script: Complex operations like creating scenes or adding nodes use a single, comprehensive GDScript file (godot_operations.gd)
that handles all operations.
The bundled script accepts operation type and parameters as JSON, allowing for flexible and dynamic operation execution without generating temporary files for each operation.
Godot Not Found: GODOT_PATH 환경 변수를 Godot 실행 파일 경로로 설정하세요
Connection Issues: 서버가 작동 중인지 확인하고 AI 어시스턴트를 재시작하세요
Invalid Project Path: 경로는 project.godot 파일을 포함하는 디렉토리를 지목해야 합니다
Build Issues: npm install 를 실행하여 모든 의존성이 설치되었는지 확인하세요
Cursor-Specific Issues
- Cursor 설정 (Settings > MCP) 에서 MCP 서버가 표시되고 활성화되어 있는지 확인하세요
- MCP 도구는 Agent 채팅 프로필 (Cursor Pro 또는 Business 구독) 만을 사용하여 실행할 수 있습니다
- "Yolo Mode" 를 사용하여 MCP 도구 요청을 자동으로 실행하세요
이 프로젝트는 MIT 라이선스를 따릅니다. 자세한 내용은 LICENSE 파일을 참조하세요.