# Godot MCP [Health: Active]

**Category:** 💻 Developer Tools  
**Repository:** https://github.com/tugcantopaloglu/godot-mcp  
**GitHub Stars:** 451  
**Views:** 0  
**Installs:** 0  
**Upvotes:** 0  
**Directory Page:** https://allmcps.com/mcp/godot-mcp-4

## Description
MCP server for full Godot 4.x engine control with 165 tools for AI-driven game development

## Claude Desktop Quick Installation
Heuristic fallback — verify the package name and runner against the repository README before running it. Uses `npx` (confidence: low):

```json
"mcpServers": {
  "godot-mcp": {
    "command": "npx",
    "args": ["-y","godot-mcp-4"]
  }
}
```

## Documentation & README


<img width="2752" height="1536" alt="godot_mcp_header" src="https://github.com/user-attachments/assets/ed7ac605-8fb5-4a5f-adf8-4b6912cbc18c" />

# Godot MCP - Full Control

[![](https://badge.mcpx.dev?type=server 'MCP Server')](https://modelcontextprotocol.io/introduction)
[![Made with Godot](https://img.shields.io/badge/Made%20with-Godot-478CBF?style=flat&logo=godot%20engine&logoColor=white)](https://godotengine.org)
[![](https://img.shields.io/badge/TypeScript-3178C6?style=flat&logo=typescript&logoColor=white 'TypeScript')](https://www.typescriptlang.org/)
[![](https://img.shields.io/badge/License-MIT-red.svg 'MIT License')](https://opensource.org/licenses/MIT)

A comprehensive [Model Context Protocol](https://modelcontextprotocol.io/introduction) (MCP) server that gives AI assistants **full control** over the Godot game engine. **157 tools** spanning networking, 3D/2D rendering, UI controls, audio effects, animation trees, file I/O, runtime code execution, property inspection, scene manipulation, signal management, physics, project creation, and more.

## Acknowledgments

This project is built upon and extends [godot-mcp](https://github.com/Coding-Solo/godot-mcp) by [Solomon Elias (Coding-Solo)](https://github.com/Coding-Solo). The original project provided the foundational architecture including the TypeScript MCP server, headless GDScript operations system, and TCP-based runtime interaction server. Thank you for making this possible with your excellent open-source work!

## What's New (Improvements Over Original)

The original godot-mcp provided 20 tools for basic project management and scene creation. This fork extends it to **157 tools** with the following major additions:

### New in 3.1
- **`validate_script` autoload resolution** - Script validation now compiles the target through a `SceneTree` at `_initialize()` (after project autoloads are registered) instead of `--check-only` at `_init()`. References to autoload singletons no longer produce false `Identifier not found` errors, while real syntax/type errors are still caught. Verified building a full game whose scripts reference several autoloads.
- **`manage_input_map` event merging** - Adding a second key to an existing input action now merges it into that action's `events` array (with `physical_keycode` de-duplication) instead of writing a duplicate `actionname=` line, which previously left `project.godot` malformed and silently dropped earlier bindings.

### New in 3.0
- **.NET / C# support** - Scaffold C# projects and generate C# scripts (`create_project` with `dotnet: true`, `create_csharp_script`); the `.csproj` SDK version is matched to your installed Godot.
- **GDScript diagnostics** - Validate scripts for syntax and type errors without running the game (`validate_script`, and `validate_scripts` for all git-changed or project-wide files).
- **Correctness and robustness fixes** across the headless scene operations and the runtime interaction server (resource-typed properties now persist, reparenting works, runtime commands are correlated by request id, and the tools survive projects with warnings-as-errors). Requires Godot 4.4 or later; tested and working with the latest Godot **4.7**.

### Runtime Code Execution
- **`game_eval`** - Execute arbitrary GDScript code in the running game with return values
- Full `await` support for async GDScript code
- Works even when the game is paused (`PROCESS_MODE_ALWAYS`)

### Runtime Node Inspection & Manipulation
- **`game_get_property`** / **`game_set_property`** - Read/write any property on any node by path
- **`game_call_method`** - Call any method on any node with arguments
- **`game_get_node_info`** - Full node introspection: properties, signals, methods, children
- **`game_instantiate_scene`** - Dynamically add scenes to the running game
- **`game_remove_node`** - Remove nodes at runtime
- **`game_change_scene`** - Switch scenes at runtime
- **`game_reparent_node`** - Move nodes between parents

### Signal System
- **`game_connect_signal`** - Wire up signal connections at runtime
- **`game_disconnect_signal`** - Remove signal connections
- **`game_emit_signal`** - Emit signals with arguments

### Animation & Tweening
- **`game_play_animation`** - Control AnimationPlayer (play, stop, pause, list)
- **`game_tween_property`** - Smooth property animation with configurable easing

### Game Control & Debugging
- **`game_pause`** - Pause/unpause the game
- **`game_performance`** - FPS, frame time, memory, object counts, draw calls
- **`game_wait`** - Wait N frames (timing-sensitive operations)
- **`game_get_nodes_in_group`** - Query nodes by group
- **`game_find_nodes_by_class`** - Find all nodes of a specific class

### Headless Scene Operations (No Running Game Needed)
- **`read_scene`** - Parse any .tscn file and get full node tree with properties as JSON
- **`modify_scene_node`** - Change node properties in scene files
- **`remove_scene_node`** - Remove nodes from scene files
- **`attach_script`** - Attach GDScript files to nodes in scenes
- **`create_resource`** - Create .tres resource files (materials, themes, etc.)

### Project Management
- **`read_project_settings`** - Parse project.godot as structured JSON
- **`modify_project_settings`** - Change project settings programmatically
- **`list_project_files`** - List and filter project files by extension

### File I/O
- **`read_file`** / **`write_file`** / **`delete_file`** - Full file system access within Godot projects
- **`create_directory`** - Create directory structures for scripts, scenes, assets

### Error & Log Capture
- **`game_get_errors`** - Get new push_error/push_warning messages since last call
- **`game_get_logs`** - Get new print output from the running game since last call

### Enhanced Input
- **`game_key_hold`** / **`game_key_release`** - Hold keys down for movement testing (WASD etc.)
- **`game_scroll`** - Mouse scroll wheel events
- **`game_mouse_drag`** - Drag between two points over multiple frames
- **`game_gamepad`** - Gamepad button and axis input events

### Project Creation & Configuration
- **`create_project`** - Create a new Godot project from scratch (pass `dotnet: true` to scaffold a .NET/C# project)
- **`create_csharp_script`** - Create a C# script in a Godot .NET project
- **`manage_autoloads`** - Add, remove, or list autoloads
- **`manage_input_map`** - Add, remove, or list input actions and key bindings
- **`manage_export_presets`** - Create or modify export preset configuration

### .NET / C# Support
- **`create_project`** with `dotnet: true` - Scaffold a Godot .NET project (`.csproj` with `Godot.NET.Sdk` matched to your Godot version, plus the `"C#"` feature flag)
- **`create_csharp_script`** - Generate an idiomatic C# script (partial class, correct `_Ready`/`_Process` override signatures); the class name is kept in sync with the file name so Godot can attach it
- **`get_project_info`** reports an `isDotnet` field

### GDScript Diagnostics
- **`validate_script`** - Check a single GDScript file for syntax and type errors headlessly, returning `{ valid, errors: [{ message, file, line }] }`
- **`validate_scripts`** - Batch-validate all git-changed `.gd` files (or the whole project), so an agent can verify its edits before running the game

### Camera, Physics & Audio
- **`game_get_camera`** / **`game_set_camera`** - Query and control 2D/3D cameras
- **`game_raycast`** - Cast physics rays (auto-detects 2D vs 3D)
- **`game_get_audio`** - Get audio bus layout and playing streams
- **`game_spawn_node`** - Create any node type at runtime with properties
- **`game_set_shader_param`** - Set shader parameters on materials
- **`game_audio_play`** / **`game_audio_bus`** - Full audio playback and bus control
- **`game_navigate_path`** - Query navigation paths (2D/3D)
- **`game_tilemap`** - Get/set TileMapLayer cells
- **`game_add_collision`** - Add collision shapes to physics bodies
- **`game_environment`** - Configure post-processing (fog, glow, SSAO, tonemap, etc.)
- **`game_manage_group`** - Add/remove nodes from groups
- **`game_create_timer`** - Create timer nodes programmatically
- **`game_set_particles`** - Configure GPUParticles2D/3D properties and process materials
- **`game_create_animation`** - Create animations with value/method/bezier/audio tracks and keyframes
- **`export_project`** - Trigger headless project export builds (CI/CD ready)
- **`game_serialize_state`** - Save/load entire node tree state as JSON
- **`game_physics_body`** - Configure mass, velocity, damping, friction, bounce
- **`game_create_joint`** - Create physics joints (pin, spring, hinge, cone, slider)
- **`game_bone_pose`** - Get/set skeleton bone poses for character animation
- **`game_ui_theme`** - Apply color, constant, and font size theme overrides
- **`game_viewport`** - Create/configure SubViewport nodes
- **`game_debug_draw`** - Draw debug geometry (lines, spheres, boxes)

### Networking
- **`game_http_request`** - HTTP GET/POST/PUT/DELETE with headers and body
- **`game_websocket`** - WebSocket client connect/disconnect/send messages
- **`game_multiplayer`** - ENet multiplayer create server/client/disconnect
- **`game_rpc`** - Call or configure RPC methods on nodes

### System & Window Control
- **`game_script`** - Attach, detach, or get source of node scripts at runtime
- **`game_window`** - Get/set window size, fullscreen, title, position
- **`game_os_info`** - Get platform, locale, screen, adapter, memory info
- **`game_time_scale`** - Get/set Engine.time_scale and timing info
- **`game_process_mode`** - Set node process mode (pausable/always/disabled)
- **`game_world_settings`** - Get/set gravity, physics FPS, and world settings

### Advanced Signals & Input
- **`game_list_signals`** - List all signals on a node with connections
- **`game_await_signal`** - Await a signal with timeout and return args
- **`game_touch`** - Simulate touch press/release/drag and gestures
- **`game_input_state`** - Query pressed keys, mouse position, connected pads
- **`game_input_action`** - Manage runtime InputMap actions and strength

### 3D Rendering & Geometry
- **`game_csg`** - Create/configure CSG nodes with boolean operations
- **`game_multimesh`** - Create/configure MultiMeshInstance3D for instancing
- **`game_procedural_mesh`** - Generate meshes via ArrayMesh from vertex data
- **`game_light_3d`** - Create/configure 3D lights (directional/omni/spot)
- **`game_mesh_instance`** - Create MeshInstance3D with primitive meshes
- **`game_gridmap`** - GridMap set/get/clear cells and query used cells
- **`game_3d_effects`** - Create ReflectionProbe, Decal, or FogVolume
- **`game_gi`** - Create/configure VoxelGI or LightmapGI
- **`game_path_3d`** - Create Path3D/Curve3D and manage curve points
- **`game_sky`** - Create/configure Sky with procedural/physical sky
- **`game_camera_attributes`** - Configure DOF, exposure, auto-exposure on camera
- **`game_navigation_3d`** - Create/configure NavigationRegion3D and bake
- **`game_physics_3d`** - Area3D queries and point/shape intersection tests

### 2D Systems
- **`game_canvas`** - Create/configure CanvasLayer and CanvasModulate
- **`game_canvas_draw`** - 2D drawing: line/rect/circle/polygon/text/clear
- **`game_light_2d`** - Create/configure 2D lights and light occluders
- **`game_parallax`** - Create/configure ParallaxBackground and layers
- **`game_shape_2d`** - Line2D/Polygon2D point manipulation
- **`game_path_2d`** - Path2D/Curve2D management and AnimatedSprite2D
- **`game_physics_2d`** - Area2D queries and 2D point/shape intersections

### Advanced Animation
- **`game_animation_tree`** - AnimationTree state machine travel and params
- **`game_animation_control`** - AnimationPlayer seek/queue/speed/info control
- **`game_skeleton_ik`** - SkeletonIK3D start/stop/set target position

### Advanced Audio
- **`game_audio_effect`** - Add/remove/configure audio bus effects
- **`game_audio_bus_layout`** - Create/remove/reorder audio buses and routing
- **`game_audio_spatial`** - Configure AudioStreamPlayer3D spatial properties

### Editor & Project Tools
- **`rename_file`** - Rename or move a file within the project
- **`manage_resource`** - Read or modify .tres/.res resource files
- **`create_script`** - Create a GDScript file from a template
- **`validate_script`** - Check a GDScript file for syntax/type errors headlessly (no run needed)
- **`validate_scripts`** - Batch-check GDScript files: git-changed ones by default, or all
- **`manage_scene_signals`** - List/add/remove signal connections in .tscn files
- **`manage_layers`** - List/set named layer definitions in project
- **`manage_plugins`** - List/enable/disable editor plugins
- **`manage_shader`** - Create or read .gdshader files
- **`manage_theme_resource`** - Create/read/modify Theme .tres resources
- **`set_main_scene`** - Set the main scene in project.godot
- **`manage_scene_structure`** - Rename/duplicate/move nodes within .tscn scenes
- **`manage_translations`** - List/add/remove translation files in project
- **`game_locale`** - Set/get locale and translate strings at runtime

### UI Controls
- **`game_ui_control`** - Set focus, anchors, tooltip, mouse filter on Control
- **`game_ui_text`** - LineEdit/TextEdit/RichTextLabel text operations
- **`game_ui_popup`** - Show/hide/popup for Popup/Dialog/Window nodes
- **`game_ui_tree`** - Tree control: get/select/collapse/add/remove items
- **`game_ui_item_list`** - ItemList/OptionButton: get/select/add/remove items
- **`game_ui_tabs`** - TabContainer/TabBar: get/set current tab
- **`game_ui_menu`** - PopupMenu/MenuBar: add/remove/get menu items
- **`game_ui_range`** - ProgressBar/Slider/SpinBox/ColorPicker get/set

### Rendering & Resources
- **`game_render_settings`** - Get/set MSAA, FXAA, TAA, scaling mode/scale
- **`game_resource`** - Runtime resource load, save, or preload

### Robustness Improvements
- **Reentrancy guard** - Prevents concurrent command processing during async operations
- **Full type conversion** - Supports Vector2/3, Color, Quaternion, Basis, Transform2D/3D, AABB, Rect2, and all packed array types
- **Smart property type detection** - Uses node's `get_property_list()` for automatic type conversion
- **PackedArray serialization** - Proper JSON arrays instead of string fallback
- **Graceful error handling** - Scene read fallback to raw .tscn text on missing dependencies

## All 157 Tools

### Project Management (7 tools)
| Tool | Description |
|------|-------------|
| `launch_editor` | Launch Godot editor for a project |
| `run_project` | Run a Godot project and capture output |
| `stop_project` | Stop the running project |
| `get_debug_output` | Get console output and errors |
| `get_godot_version` | Get installed Godot version |
| `list_projects` | Find Godot projects in a directory |
| `get_project_info` | Get project metadata |

### Scene Management (7 tools)
| Tool | Description |
|------|-------------|
| `create_scene` | Create a new scene with a root node type |
| `add_node` | Add a node to an existing scene |
| `load_sprite` | Load a texture into a Sprite2D node |
| `export_mesh_library` | Export a scene as MeshLibrary |
| `save_scene` | Save a scene (with optional variant path) |
| `get_uid` | Get UID for a file (Godot 4.4+) |
| `update_project_uids` | Resave resources to update UIDs |

### Headless Scene Operations (5 tools)
| Tool | Description |
|------|-------------|
| `read_scene` | Read full scene tree as JSON |
| `modify_scene_node` | Modify node properties in a scene file |
| `remove_scene_node` | Remove a node from a scene file |
| `attach_script` | Attach a GDScript to a scene node |
| `create_resource` | Create a .tres resource file |

### Project Settings (3 tools)
| Tool | Description |
|------|-------------|
| `read_project_settings` | Parse project.godot as JSON |
| `modify_project_settings` | Change a project setting |
| `list_project_files` | List/filter project files |

### Runtime Input (4 tools)
| Tool | Description |
|------|-------------|
| `game_screenshot` | Capture a screenshot (base64 PNG) |
| `game_click` | Click at a position |
| `game_key_press` | Send key press or input action |
| `game_mouse_move` | Move the mouse |

### Runtime Inspection (3 tools)
| Tool | Description |
|------|-------------|
| `game_get_ui` | Get all visible UI elements |
| `game_get_scene_tree` | Get full scene tree structure |
| `game_get_node_info` | Detailed node introspection |

### Runtime Code Execution (1 tool)
| Tool | Description |
|------|-------------|
| `game_eval` | Execute arbitrary GDScript with return values |

### Runtime Node Manipulation (7 tools)
| Tool | Description |
|------|-------------|
| `game_get_property` | Get any node property |
| `game_set_property` | Set any node property (auto type conversion) |
| `game_call_method` | Call any method on a node |
| `game_instantiate_scene` | Add a PackedScene to the running tree |
| `game_remove_node` | Remove a node from the tree |
| `game_change_scene` | Switch to a different scene |
| `game_reparent_node` | Move a node to a new parent |

### Runtime Signals (5 tools)
| Tool | Description |
|------|-------------|
| `game_connect_signal` | Connect a signal to a method |
| `game_disconnect_signal` | Disconnect a signal |
| `game_emit_signal` | Emit a signal with arguments |
| `game_list_signals` | List all signals on a node with connections |
| `game_await_signal` | Await a signal with timeout and return args |

### Runtime Animation (2 tools)
| Tool | Description |
|------|-------------|
| `game_play_animation` | Control AnimationPlayer |
| `game_tween_property` | Tween a property with easing |

### Runtime Utilities (5 tools)
| Tool | Description |
|------|-------------|
| `game_pause` | Pause/unpause the game |
| `game_performance` | Get FPS, memory, draw calls |
| `game_wait` | Wait N frames |
| `game_get_nodes_in_group` | Query nodes by group |
| `game_find_nodes_by_class` | Find nodes by class type |

### File I/O (4 tools)
| Tool | Description |
|------|-------------|
| `read_file` | Read a text file from a Godot project |
| `write_file` | Create or overwrite a text file |
| `delete_file` | Delete a file from a project |
| `create_directory` | Create a directory inside a project |

### Error & Log Capture (2 tools)
| Tool | Description |
|------|-------------|
| `game_get_errors` | Get new errors/warnings since last call |
| `game_get_logs` | Get new print output since last call |

### Enhanced Input (8 tools)
| Tool | Description |
|------|-------------|
| `game_key_hold` | Hold a key down (no auto-release) |
| `game_key_release` | Release a held key |
| `game_scroll` | Mouse scroll wheel event |
| `game_mouse_drag` | Drag between two points over N frames |
| `game_gamepad` | Gamepad button or axis input |
| `game_touch` | Simulate touch press/release/drag and gestures |
| `game_input_state` | Query pressed keys, mouse position, connected pads |
| `game_input_action` | Manage runtime InputMap actions and strength |

### Project Creation (5 tools)
| Tool | Description |
|------|-------------|
| `create_project` | Create a new Godot project (supports `dotnet: true` for C#) |
| `create_csharp_script` | Create a C# script in a Godot .NET project |
| `manage_autoloads` | Add, remove, or list autoloads |
| `manage_input_map` | Add, remove, or list input actions |
| `manage_export_presets` | Create or modify export presets |

### Advanced Runtime (24 tools)
| Tool | Description |
|------|-------------|
| `game_get_camera` | Get active camera position/rotation/zoom |
| `game_set_camera` | Move or rotate the active camera |
| `game_raycast` | Cast a ray and return collision results |
| `game_get_audio` | Get audio bus layout and playing streams |
| `game_spawn_node` | Create a new node of any type at runtime |
| `game_set_shader_param` | Set a shader parameter on a node's material |
| `game_audio_play` | Play, stop, or pause an AudioStreamPlayer node |
| `game_audio_bus` | Set volume, mute, or solo on an audio bus |
| `game_navigate_path` | Query a navigation path between two points |
| `game_tilemap` | Get or set cells in a TileMapLayer node |
| `game_add_collision` | Add a collision shape to a physics body node |
| `game_environment` | Get or set environment and post-processing settings |
| `game_manage_group` | Add or remove a node from a group, or list groups |
| `game_create_timer` | Create a Timer node with configuration |
| `game_set_particles` | Configure GPUParticles2D/3D node properties |
| `game_create_animation` | Create an animation with tracks and keyframes |
| `game_serialize_state` | Save or load node tree state as JSON |
| `game_physics_body` | Configure physics body properties (mass, velocity) |
| `game_create_joint` | Create a physics joint between two bodies |
| `game_bone_pose` | Get or set bone poses on a Skeleton3D node |
| `game_ui_theme` | Apply theme overrides to a Control node |
| `game_viewport` | Create or configure a SubViewport node |
| `game_debug_draw` | Draw debug lines, spheres, or boxes in 3D |

### Build & Export (1 tool)
| Tool | Description |
|------|-------------|
| `export_project` | Export a Godot project using a preset |

### Networking (4 tools)
| Tool | Description |
|------|-------------|
| `game_http_request` | HTTP GET/POST/PUT/DELETE with headers and body |
| `game_websocket` | WebSocket client connect/disconnect/send messages |
| `game_multiplayer` | ENet multiplayer create server/client/disconnect |
| `game_rpc` | Call or configure RPC methods on nodes |

### System & Window (6 tools)
| Tool | Description |
|------|-------------|
| `game_script` | Attach, detach, or get source of node scripts |
| `game_window` | Get/set window size, fullscreen, title, position |
| `game_os_info` | Get platform, locale, screen, adapter, memory info |
| `game_time_scale` | Get/set Engine.time_scale and timing info |
| `game_process_mode` | Set node process mode (pausable/always/disabled) |
| `game_world_settings` | Get/set gravity, physics FPS, and world settings |

### 3D Rendering & Geometry (13 tools)
| Tool | Description |
|------|-------------|
| `game_csg` | Create/configure CSG nodes with boolean operations |
| `game_multimesh` | Create/configure MultiMeshInstance3D for instancing |
| `game_procedural_mesh` | Generate meshes via ArrayMesh from vertex data |
| `game_light_3d` | Create/configure 3D lights (directional/omni/spot) |
| `game_mesh_instance` | Create MeshInstance3D with primitive meshes |
| `game_gridmap` | GridMap set/get/clear cells and query used cells |
| `game_3d_effects` | Create ReflectionProbe, Decal, or FogVolume |
| `game_gi` | Create/configure VoxelGI or LightmapGI |
| `game_path_3d` | Create Path3D/Curve3D and manage curve points |
| `game_sky` | Create/configure Sky with procedural/physical sky |
| `game_camera_attributes` | Configure DOF, exposure, auto-exposure on camera |
| `game_navigation_3d` | Create/configure NavigationRegion3D and bake |
| `game_physics_3d` | Area3D queries and point/shape intersection tests |

### 2D Systems (7 tools)
| Tool | Description |
|------|-------------|
| `game_canvas` | Create/configure CanvasLayer and CanvasModulate |
| `game_canvas_draw` | 2D drawing: line/rect/circle/polygon/text/clear |
| `game_light_2d` | Create/configure 2D lights and light occluders |
| `game_parallax` | Create/configure ParallaxBackground and layers |
| `game_shape_2d` | Line2D/Polygon2D point manipulation |
| `game_path_2d` | Path2D/Curve2D management and AnimatedSprite2D |
| `game_physics_2d` | Area2D queries and 2D point/shape intersections |

### Advanced Animation (3 tools)
| Tool | Description |
|------|-------------|
| `game_animation_tree` | AnimationTree state machine travel and params |
| `game_animation_control` | AnimationPlayer seek/queue/speed/info control |
| `game_skeleton_ik` | SkeletonIK3D start/stop/set target position |

### Advanced Audio (3 tools)
| Tool | Description |
|------|-------------|
| `game_audio_effect` | Add/remove/configure audio bus effects |
| `game_audio_bus_layout` | Create/remove/reorder audio buses and routing |
| `game_audio_spatial` | Configure AudioStreamPlayer3D spatial properties |

### Editor & Project Tools (14 tools)
| Tool | Description |
|------|-------------|
| `rename_file` | Rename or move a file within the project |
| `manage_resource` | Read or modify .tres/.res resource files |
| `create_script` | Create a GDScript file from a template |
| `validate_script` | Check a GDScript file for syntax/type errors (headless) |
| `validate_scripts` | Batch-check GDScript files (git-changed by default, or all) |
| `manage_scene_signals` | List/add/remove signal connections in .tscn files |
| `manage_layers` | List/set named layer definitions in project |
| `manage_plugins` | List/enable/disable editor plugins |
| `manage_shader` | Create or read .gdshader files |
| `manage_theme_resource` | Create/read/modify Theme .tres resources |
| `set_main_scene` | Set the main scene in project.godot |
| `manage_scene_structure` | Rename/duplicate/move nodes within .tscn scenes |
| `manage_translations` | List/add/remove translation files in project |
| `game_locale` | Set/get locale and translate strings at runtime |

### UI Controls (8 tools)
| Tool | Description |
|------|-------------|
| `game_ui_control` | Set focus, anchors, tooltip, mouse filter on Control |
| `game_ui_text` | LineEdit/TextEdit/RichTextLabel text operations |
| `game_ui_popup` | Show/hide/popup for Popup/Dialog/Window nodes |
| `game_ui_tree` | Tree control: get/select/collapse/add/remove items |
| `game_ui_item_list` | ItemList/OptionButton: get/select/add/remove items |
| `game_ui_tabs` | TabContainer/TabBar: get/set current tab |
| `game_ui_menu` | PopupMenu/MenuBar: add/remove/get menu items |
| `game_ui_range` | ProgressBar/Slider/SpinBox/ColorPicker get/set |

### Rendering & Resources (2 tools)
| Tool | Description |
|------|-------------|
| `game_render_settings` | Get/set MSAA, FXAA, TAA, scaling mode/scale |
| `game_resource` | Runtime resource load, save, or preload |

## Requirements

- [Godot Engine](https://godotengine.org/download) 4.4 or later (the headless operations script and UID features require 4.4+); tested and working with the latest Godot **4.7**
- (Optional) [.NET SDK](https://dotnet.microsoft.com/download) 8.0+ and the Godot .NET (C#) build, only if you use `create_project`'s `dotnet: true` flag or `create_csharp_script`
- [Node.js](https://nodejs.org/) >= 18.0.0
- An AI assistant that supports MCP (Claude Code, Cline, Cursor, etc.)

## Installation

```bash
git clone https://github.com/tugcantopaloglu/godot-mcp.git
cd godot-mcp
npm install
npm run build
```

## Configuration

### Claude Code

Add to your Claude Code MCP settings:

```json
{
  "mcpServers": {
    "godot": {
      "command": "node",
      "args": ["/absolute/path/to/godot-mcp/build/index.js"],
      "env": {
        "GODOT_PATH": "/path/to/godot",
        "DEBUG": "true"
      }
    }
  }
}
```

### Cline (VS Code)

Add to your Cline MCP settings (`cline_mcp_settings.json`):

```json
{
  "mcpServers": {
    "godot": {
      "command": "node",
      "args": ["/absolute/path/to/godot-mcp/build/index.js"],
      "disabled": false
    }
  }
}
```

### Cursor

Create `.cursor/mcp.json` in your project:

```json
{
  "mcpServers": {
    "godot": {
      "command": "node",
      "args": ["/absolute/path/to/godot-mcp/build/index.js"]
    }
  }
}
```

## Runtime Tools Setup

To use the `game_*` runtime tools, your Godot project needs the MCP interaction server autoload. Copy `build/scripts/mcp_interaction_server.gd` to your project and register it as an autoload:

1. Copy `build/scripts/mcp_interaction_server.gd` to your project's scripts folder
2. In Godot: **Project > Project Settings > Autoload**
3. Add the script with the name `McpInteractionServer`

The server listens on `127.0.0.1:9090` and accepts JSON commands over TCP when the game is running.

## Environment Variables

| Variable | Description |
|----------|-------------|
| `GODOT_PATH` | Path to the Godot executable (overrides auto-detection) |
| `DEBUG` | Set to `"true"` for detailed server-side logging |
| `GODOT_MCP_ALLOWED_DIRS` | Optional. Restrict `run_project` to projects under these roots (`;`, `,`, or `:` separated). When unset, any project path is allowed. |

## Architecture

The server uses two communication channels:

1. **Headless CLI** - For operations that don't need a running game (scene reading, modification, resource creation). Runs Godot with `--headless --script godot_operations.gd <operation> <json_params>`.

2. **TCP Socket** - For runtime interaction with a running game. The `mcp_interaction_server.gd` autoload listens on port 9090 and processes JSON commands sent by the TypeScript MCP server.

### Source layout

| Path | Description |
|------|-------------|
| `src/index.ts` | MCP server, tool definitions, and all handlers |
| `src/utils.ts` | Pure utility functions (parameter mapping, validation, error helpers) |
| `src/scripts/godot_operations.gd` | Headless GDScript operations runner |
| `src/scripts/mcp_interaction_server.gd` | TCP interaction server autoload |
| `tests/` | Vitest test suite |

## Testing

The project uses [Vitest](https://vitest.dev/) with 446 tests across 5 files:

| File | Tests | What it covers |
|------|-------|----------------|
| `tests/utils.test.ts` | 31 | Parameter mappings, normalization, path validation, error responses, version detection |
| `tests/tool-definitions.test.ts` | 163 | All 155 tools defined, schemas valid, names unique, descriptions < 80 chars |
| `tests/handlers.test.ts` | 225 | Game command arg transforms, required-param validation, headless op path checks, source structure |
| `tests/dotnet.test.ts` | 20 | .NET feature flag, .csproj generation, C# script template generation, identifier validation |
| `tests/validate-script.test.ts` | 12 | GDScript diagnostic parsing + git-changed file collection |

```bash
npm test          # run once
npm run test:watch  # watch mode
```

## Example Prompts

```text
"Run my Godot project and check for errors"

"Eval this in my running game: return get_tree().current_scene.name"

"Get the player's position in the running game"

"Set the player's health to 100"

"Read the test_level.tscn scene and show me the node tree"

"Change the player's speed property in the player.tscn scene file"

"List all .gd files in my project"

"Connect the enemy's 'died' signal to the game manager's 'on_enemy_died' method"

"Tween the camera's position to (0, 10, -5) over 2 seconds with ease-out"

"Get performance metrics - what's my FPS and draw call count?"

"Pause the game and take a screenshot"

"Find all CharacterBody3D nodes in the scene"

"Create a new Godot project called 'MyGame' and write a player script"

"Create a new C# (.NET) Godot project and add a CharacterBody2D script"

"Validate player.gd for errors"

"Check all my changed GDScript files for syntax errors before I run the game"

"Hold down the W key for 2 seconds to test walking"

"Cast a ray from the player downward to check for ground"

"Get the camera position and move it to look at the player"

"Show me the latest error messages from the running game"
```

## License

This project is licensed under the MIT License - see the [LICENSE](https://github.com/tugcantopaloglu/godot-mcp/blob/HEAD/LICENSE) file for details.

## Credits

- **Original project**: [godot-mcp](https://github.com/Coding-Solo/godot-mcp) by [Solomon Elias (Coding-Solo)](https://github.com/Coding-Solo) - provided the foundational MCP server architecture, headless operations system, and TCP interaction framework
- **Extended by**: [Tugcan Topaloglu](https://github.com/tugcantopaloglu) - extended to 157 tools covering networking, 3D/2D rendering, UI controls, audio effects, animation trees, file I/O, runtime code execution, node manipulation, signals, project creation, camera control, physics, and comprehensive type conversion