Godot MCP
Provides tools for interacting with the Godot Engine editor, enabling AI agents to manipulate nodes, tilemaps, animations, scenes, physics, and execute GDScript in a running Godot project.
Click on "Deploy Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@Godot MCP Create a 2D platformer scene with a player node and a tilemap using the starter tileset."
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
๐ What is Godot MCP?
Godot MCP transforms the Godot Editor into an autonomous, AI-driven game development environment. Using Anthropic's Model Context Protocol (MCP), it gives AI coding assistants (such as Google Antigravity, Claude Code, Cursor, Windsurf, VS Code, and OpenAI Codex) direct, native, structured control over your running Godot project.
With Godot MCP, your AI assistant doesn't just suggest code snippetsโit can:
๐บ๏ธ Paint, rotate, flip, and manipulate TileMaps on the fly.
๐ฌ Create animations, insert keyframes, and generate dynamic presets (spins, bounces, fades, slides).
๐ Transform nodes (rotate, scale, translate) in 2D and 3D with full Undo/Redo support.
โก Execute arbitrary live GDScript (
godot_eval) with instant return values.๐ฑ๏ธ Operate editor docks, inspectors, and menus through semantic UI automation.
๐ฎ Build complete game scenes, configure physics, attach scripts, and manage audio buses.
Related MCP server: Godot MCP
โก Key Highlights
๐ฎ 1,776 Canonical Engine Operations: Complete coverage spanning 2D/3D physics, rendering, shaders, materials, skeletal animations, particles, audio buses, tilemaps, gridmaps, CSG modeling, navigation meshes, UI controls, project settings, scene composition, Trail3D, texture streaming, and dynamic ClassDB discovery.
๐ง Adaptive Tool Exposure Engine: Seamlessly overcomes LLM context bloat and hard tool caps (such as Antigravity's 100-tool limit) using 5 distinct exposure strategies:
AUTO: Automatically detects connected client capabilities and selects optimal density.FULL: Exposes all 1,776 granular tools for agents supporting unbounded tool catalogs.DOMAIN: Groups operations into 61 high-level domain rollups (fits comfortably within 100-tool limits).LAZY: Provides 33 core operational tools and discovers remaining tools on demand.ROUTER: Minimal 4-tool interface (omni_execute,omni_search,omni_describe,omni_stats) with sub-millisecond p50 dispatch.
โก Arbitrary GDScript Omnipotence (
godot_eval/omni_eval): Execute ephemeral@toolGDScript directly inside the running Godot editor with full access toEditorInterface,ProjectSettings, singletons, and ClassDB without leaving residual files.๐ Universal Object Reflection (
obj://session/id): Stateful handle management with generational safety counters, cycle detection, and bidirectional serialization across all 38+ Godot Variant types.๐ฑ Semantic UI Automation: Autonomous editor control tree inspection, widget traversal, button clicking, text input, and keyboard shortcut dispatch.
๐ Broad Version Compatibility: Zero-regression support from Godot 4.1 through Godot 4.8+ (including active Godot 4.8 development snapshots).
๐ค 12 Supported AI Clients: One-command automatic configuration for Antigravity, Claude Code, Claude Desktop, Cursor, Windsurf, VS Code, Cline, Roo Code, OpenAI Codex, OpenCode, Zed, and Gemini CLI.
๐ Quick Start
1. Requirements
Godot Engine: 4.1, 4.2, 4.3, 4.4, 4.5, 4.6, 4.7, or 4.8+ (including 4.8 dev snapshots)
Python: 3.11 โ 3.14
Astral uv (recommended) or
pip
2. Install the Godot Plugin
Option A: From Godot Asset Library (Recommended)
Open your Godot project.
Click the AssetLib tab at the top of the editor.
Search for Godot Omni (or Godot MCP) and click Download โ Install.
Option B: Manual Installation
Copy the addons/godot_omni and addons/godot_ai directories from this repository into your Godot project's res://addons/ directory:
your-godot-project/
โโโ addons/
โโโ godot_omni/
โ โโโ plugin.cfg
โ โโโ plugin.gd
โ โโโ omni_dock.gd
โ โโโ omni_reflection.gd
โ โโโ omni_ui_tree.gd
โโโ godot_ai/
โโโ plugin.cfg
โโโ plugin.gd
โโโ handlers/
โโโ omni_handler.gdOption C: Enable the Plugin
In Godot, navigate to: Project โ Project Settings โ Plugins and enable Godot Omni (or Godot AI).
The plugin will start the loopback WebSocket server and open the Godot AI / Omni dock in the bottom editor panel.
3. Install the Python MCP Server
# Clone the repository
git clone https://github.com/bebabinlarsson-blip/Godot-MCP.git
cd "Godot-MCP"
# Install with dev dependencies using uv
uv sync --extra dev
# Or install via pip
pip install -e .
Verify your installation:
godot-omni self-test
godot-omni tools stats4. Connect Your AI Client
You can automatically configure your AI client with a single CLI command:
# Configure all detected clients on your system
godot-omni clients configure all
# Or configure a specific client:
godot-omni clients configure antigravity
godot-omni clients configure claude-code
godot-omni clients configure claude-desktop
godot-omni clients configure cursor
godot-omni clients configure windsurf
godot-omni clients configure vscodeManual Client Configuration (JSON)
If you prefer manual configuration, add the following to your client's MCP configuration file (e.g., claude_desktop_config.json, .cursor/mcp.json, or Antigravity MCP settings):
{
"mcpServers": {
"godot-omni": {
"command": "godot-omni",
"args": ["attach"]
}
}
}๐ค How the AI Uses It: Tool Capabilities & Examples
Godot MCP provides high-level and granular tools designed specifically for AI agent reasoning:
1. ๐บ๏ธ TileMap Manipulation & Rotation
The AI can paint, rotate, flip, and clear tiles dynamically:
// Place a tile with 90ยฐ clockwise rotation and horizontal flip:
call("godot-ai", "tilemap_manage", {
"op": "tilemap_place_tile",
"path": "/Main/World/TileMapLayer",
"source_id": 0,
"atlas_col": 3,
"atlas_row": 1,
"map_x": 12,
"map_y": 8,
"rotation_degrees": 90,
"flip_h": true
})
// Rotate an existing tile by 180 degrees:
call("godot-ai", "tilemap_manage", {
"op": "tilemap_rotate_cell",
"path": "/Main/World/TileMapLayer",
"map_x": 12,
"map_y": 8,
"degrees": 180
})2. ๐ฌ Animation Clips, Tracks & Motion Presets
The AI can build complex animations from scratch or use one-call presets:
// One-call 360ยฐ smooth spin preset:
call("godot-ai", "animation_manage", {
"op": "preset_spin",
"player_path": "/Main/Player/AnimationPlayer",
"target_path": "Sprite2D",
"duration": 0.8,
"loop": true
})
// One-call jump / bounce preset:
call("godot-ai", "animation_manage", {
"op": "preset_bounce",
"player_path": "/Main/Player/AnimationPlayer",
"target_path": "Sprite2D",
"height": 45.0,
"duration": 0.5
})3. ๐ Node Spatial Transformations
Direct, undoable rotation, scaling, and translation for 2D, 3D, and Control nodes:
// Rotate node:
call("godot-ai", "node_manage", {
"op": "rotate",
"path": "/Main/Enemy",
"degrees": 45.0,
"relative": true
})
// Scale node:
call("godot-ai", "node_manage", {
"op": "scale",
"path": "/Main/Enemy",
"scale": [1.5, 1.5],
"relative": false
})4. โก Live GDScript Evaluation (godot_eval)
When an agent needs custom logic or complex editor manipulation, it executes ephemeral GDScript in memory:
# The AI sends GDScript to run inside the editor:
func run():
var editor = EditorInterface
var scene = editor.get_edited_scene_root()
print("Found scene root: ", scene.name)
return {"status": "ok", "children_count": scene.get_child_count()}๐ System Architecture
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
โ AI Client โ
โ (Antigravity / Claude Code / Cursor / Windsurf / ...) โ
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฌโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
โ stdio (FastMCP Protocol)
โผ
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
โ Godot MCP Python Server โ
โ โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ โ
โ โ Adaptive Exposure Engine (AUTO/FULL/DOMAIN/LAZY) โ โ
โ โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโค โ
โ โ Canonical Registry: 1,763 Operations / 58 Domains โ โ
โ โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโค โ
โ โ Universal Reflection Handle Manager (obj://...) โ โ
โ โโโโโโโโโโโโโโโโโโโโโโโโโโโโโฌโโโโโโโโโโโโโโโโโโโโโโโโโโโโ โ
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโผโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
โ Loopback WebSocket (Port 9500)
โ (Rotating Token Authentication)
โผ
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
โ Godot Editor Plugin (addons/) โ
โ โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ โ
โ โ omni_handler.gd (WebSocket In-Editor Dispatch) โ โ
โ โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโค โ
โ โ godot_eval (Ephemeral @tool GDScript Execution) โ โ
โ โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโค โ
โ โ omni_reflection.gd (Variant โ JSON Serialization) โ โ
โ โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโค โ
โ โ omni_ui_tree.gd (Semantic Control Automation) โ โ
โ โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโค โ
โ โ Godot Engine APIs: ClassDB, EditorInterface, Nodes โ โ
โ โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ โ
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ๐ Unified CLI Reference
Godot MCP includes a powerful unified CLI (godot-omni or godot-mcp):
# 1. Tools & Registry
godot-omni tools stats # Summary of 1,763 operations across 58 domains
godot-omni tools search "camera" # Search operations across all domains
godot-omni tools describe node_create # Detailed schema, parameters, and Godot class
godot-omni tools list --domain physics_3d # List all tools in a specific domain
godot-omni tools export schema.json # Export complete JSON catalog
# 2. Client Management
godot-omni clients detect # Detect installed AI clients on host
godot-omni clients status # Check MCP registration status across 12 clients
godot-omni clients configure <name> # Auto-configure specific client
godot-omni clients configure all # Auto-configure all detected clients
godot-omni clients doctor # Validate client configs and report syntax errors
# 3. Performance & Benchmarks
godot-omni benchmark all # Run end-to-end performance benchmarks
godot-omni benchmark tools # Measure tool lookup & execution latency
godot-omni benchmark memory # Monitor memory consumption and handle footprint
# 4. Diagnostics & Health
godot-omni doctor # Full diagnostics: Python, Godot, network, registry
godot-omni self-test # 8-point in-process integration test
godot-omni versions status # Godot 4.1 โ 4.8+ compatibility breakdown๐ Operations Breakdown
Godot MCP classifies its 1,763 operations into 5 architectural layers:
Layer | Operations | Description |
Curated Core | 262 | High-level operations for nodes, scenes, scripts, resources, project settings, files. |
ClassDB Generated | 1,370 | Automatically generated wrappers for Godot engine classes and methods. |
UI Automation | 54 | Full traversal, widget inspection, click, input, and shortcut dispatch for the editor GUI. |
Runtime Execution | 66 | Play-in-editor monitoring, game process lifecycle, runtime capture, test suites. |
Universal Reflection | 11 | Handle resolution, property read/write, method invocation, and variant serialization. |
Total | 1,763 | 58 unique engine domains |
For full breakdown and domain catalog, see reports/tool-coverage.md.
๐ Security & Privacy
Local Loopback Isolation: All network communication occurs strictly over
127.0.0.1on local loopback sockets. External network access is never opened.Rotating Cryptographic Capabilities: WebSocket communication between the Python MCP server and the Godot editor uses per-session cryptographic tokens stored with strict
0700user permissions.Ephemeral GDScript Execution: Dynamic code evaluated via
godot_evalruns in memory as transient@toolscripts and leaves no untracked residual files.Zero Telemetry Exfiltration: Code, scene hierarchies, script contents, and file paths are never transmitted. Telemetry can be completely disabled with
GODOT_AI_DISABLE_TELEMETRY=true.
See SECURITY.md for vulnerability reporting guidelines.
๐ค Author & Maintainer
Created and maintained by bebabin.
๐ค Contributing
Contributions are welcome! Please see CONTRIBUTING.md for development environment setup, test guidelines, and PR procedures.
๐ License
This project is licensed under the MIT License.
Available Tools
46 toolsanimation_createA
Create a new Animation clip inside an AnimationPlayer's default library.
After creating the clip, add tracks via animation_manage ops
add_property_track / add_method_track / create_simple.
Track node paths are stored relative to the AnimationPlayer's
root_node (default: its parent), not to the scene root โ see
animation_manage preset ops for a forgiving target_path that
accepts either form.
If player_path doesn't resolve, an AnimationPlayer is auto-created
at that path (parent must exist).
Inputs: name (required), length (required), player_path (required), loop_mode, +2 more. Returns: object
animation_manageA
AnimationPlayer authoring (player, tracks, autoplay, presets, playback).
Ops: โข player_create(parent_path, name="AnimationPlayer") Create an AnimationPlayer with empty default library. โข delete(player_path, animation_name) Delete an animation clip from the default library. Undoable. โข validate(player_path, animation_name) Check all track paths resolve. Returns broken_count + per-track issues. โข add_property_track(player_path, animation_name, track_path, keyframes, interpolation="linear") Add a property track. track_path: "NodeName:property". keyframes: [{time, value, transition?}, ...]. interpolation: linear|nearest|cubic. โข add_method_track(player_path, animation_name, target_node_path, keyframes) Add a method track. keyframes: [{time, method, args?}, ...]. โข set_autoplay(player_path, animation_name="") Set autoplay. Empty animation_name clears. โข play(player_path, animation_name="") Editor preview. Not saved with scene. โข stop(player_path) Stop editor preview. Not saved with scene. โข list(player_path) List animations with length, loop_mode, track_count. โข get(player_path, animation_name) Inspect a clip's tracks and keyframes in detail. โข create_simple(player_path, name, tweens, length=None, loop_mode="none", overwrite=False) High-level: build a multi-track clip from tween specs in one call. tweens: [{target, property, from, to, duration, delay?, transition?}]. โข preset_fade(player_path, target_path, mode="in", duration=0.5, animation_name="", overwrite=False) One-call fade-in/out (modulate.a). โข preset_slide(player_path, target_path, direction="left", mode="in", distance=None, duration=0.4, animation_name="", overwrite=False) One-call slide-in/out (position). โข preset_shake(player_path, target_path, intensity=None, duration=0.3, frequency=30.0, seed=0, animation_name="", overwrite=False) One-call shake (jittered position). โข preset_pulse(player_path, target_path, from_scale=1.0, to_scale=1.1, duration=0.4, animation_name="", overwrite=False) One-call pulse / hover-bounce (3-keyframe scale ping-pong).
Preset target_path: accepts either a scene-absolute path (e.g. "/Main/World/Cube",
matching every other scene tool) or a path relative to the AnimationPlayer's
root_node (e.g. "World/Cube", matching how Animation tracks store node paths).
Scene-absolute targets outside the player's root_node subtree are converted to
a ..-prefixed track path via root_node.get_path_to(target), the same shape
the relative form already accepts.
Canonical call shape: {"op": "<verb>", "params": {...}}. Flat op parameters are accepted as a compatibility alias when the client transmits them; op and session_id remain top-level.
Inputs: op (required), params, session_id. Returns: object
api_manageA
Inspect Godot API documentation-shaped metadata from the connected editor's ClassDB: "what properties does X have", method signatures, signals, enums, constants, defaults, and property hint strings.
Resource form (prefer for active-session reads): godot://class/{class_name}
Ops:
get_class(class_name, sections=None, include_inherited=False, include_inheritors=False, offset=0, limit=100) Return selected class-reference sections without creating a scene instance. sections may be a comma-separated string or list containing properties, methods, signals, enums, constants, inheritors. Defaults to ["properties"] only โ a bare get_class answers "what properties does X have" without the multi-thousand-token full dump. Pass the sections you want by name, or "all" for the full set (properties, methods, signals, enums, constants). "all" does NOT include the heavier "inheritors" section โ request that by name. For pagination, request one section at a time so offset/limit apply only to the list you are paging.
Canonical call shape: {"op": "<verb>", "params": {...}}. Flat op parameters are accepted as a compatibility alias when the client transmits them; op and session_id remain top-level.
Inputs: op (required), params, session_id. Returns: object
audio_manageA
Sound effects, music, ambience (AudioStreamPlayer / 2D / 3D).
Ops: โข player_create(parent_path, name="AudioStreamPlayer", type="1d") Create an AudioStreamPlayer / 2D / 3D node. type: "1d" | "2d" | "3d". โข player_set_stream(player_path, stream_path) Assign an AudioStream resource (.ogg/.wav/.mp3 or .tres). Returns duration_seconds. โข player_set_playback(player_path, volume_db?, pitch_scale?, autoplay?, bus?) Update common playback properties atomically. Pass only fields to change; at least one of volume_db/pitch_scale/autoplay/bus required. โข play(player_path, from_position=0.0) Start real editor preview playback. Not undoable. โข stop(player_path) Stop editor preview playback. Not undoable. โข list(root="res://", include_duration=True) Scan project for AudioStream resources (every subclass + .tres/.res).
Canonical call shape: {"op": "<verb>", "params": {...}}. Flat op parameters are accepted as a compatibility alias when the client transmits them; op and session_id remain top-level.
Inputs: op (required), params, session_id. Returns: object
autoload_manageA
Autoload (global singleton) management. Autoloads are scripts or scenes
loaded automatically at project start, accessible globally by name when
singleton=True. Persisted to project.godot.
Ops:
โข list()
List autoloads with name, path, and singleton flag.
โข add(name, path, singleton=True)
Register an autoload (script or PackedScene) by res:// path.
โข remove(name)
Unregister an autoload by name. The underlying file is not deleted.
Canonical call shape: {"op": "<verb>", "params": {...}}. Flat op parameters are accepted as a compatibility alias when the client transmits them; op and session_id remain top-level.
Inputs: op (required), params, session_id. Returns: object
batch_executeA
Execute a list of editor sub-commands in order, stopping on first error.
Each item must be {"command": "<plugin_command>", "params": {...}}.
Use the underlying plugin command names (e.g. create_node, set_property,
delete_node, attach_script), not the MCP tool names. Commands run
sequentially; execution stops at the first error. When undo is True
(default), any successful sub-commands are rolled back via the scene's
undo history if a later sub-command fails, producing atomic-on-failure
semantics.
Use this to compose multi-step edits (create node + set property +
attach script) into a single tool call. Rollback works for sub-commands
that modify the currently edited scene. batch_execute itself is not
allowed as a sub-command.
Scene paths are relative to the edited scene root (e.g. "/Main/Enemy"), NOT runtime "/root/..." paths. The example below assumes the scene root is named "Main" โ substitute the actual root name.
Inputs: commands (required), undo, session_id. Returns: object
camera_manageA
Camera2D / Camera3D authoring (zoom, FOV, projection, smoothing, follow).
Ops: โข create(parent_path, name="Camera", type="2d", make_current=False) Create a Camera2D ("2d") or Camera3D ("3d"). When make_current=True, unmarks previously current cameras of the same class in one undo. โข configure(camera_path, properties) Batch-set camera-specific properties (zoom, fov, projection, smoothing, drag, limits โฆ). Class-aware. Enum-by-name (projection, keep_aspect, anchor_mode, doppler_tracking, process_callback). Vector2 dict coercion for zoom/offset. Transforms (position, rotation, scale, transform, global_*) live on the Node โ set those via node_set_property, not here. โข set_limits_2d(camera_path, left?, right?, top?, bottom?, smoothed?) Set Camera2D bounds. Pass only the edges to change. โข set_damping_2d(camera_path, position_speed?, rotation_speed?, drag_margins?, drag_horizontal_enabled?, drag_vertical_enabled?) Smooth Camera2D motion (position/rotation smoothing speeds + drag deadzone). drag_margins: {left,top,right,bottom} fractions [0,1]. โข follow_2d(camera_path, target_path, smoothing_speed=5.0, zero_transform=True) Reparent camera under target with smoothing โ Godot-native follow. โข get(camera_path="") Inspect a camera (class, current flag, all properties). Empty path resolves to the currently-active camera, falling back to the first. โข list() List every Camera2D/Camera3D in the scene. โข apply_preset(parent_path, name, preset, type=None, make_current=True, overrides=None) Spawn with opinionated defaults. Presets: topdown_2d, platformer_2d, cinematic_3d, action_3d. overrides merge over preset values.
Canonical call shape: {"op": "<verb>", "params": {...}}. Flat op parameters are accepted as a compatibility alias when the client transmits them; op and session_id remain top-level.
Inputs: op (required), params, session_id. Returns: object
client_manageA
Configure AI clients to use this Godot AI MCP server. Writes / removes client config files (Claude Code, Codex, Antigravity, Cursor, Devin Desktop (Windsurf), Zed, etc.).
Ops:
โข status()
List every supported client with id, display_name, status
(configured | not_configured | configured_mismatch | error),
and installed flag.
โข configure(client)
Write the MCP server entry into the named client's config file.
client is one of the ids returned by status().
โข remove(client)
Remove this server's entry from the named client's config.
Canonical call shape: {"op": "<verb>", "params": {...}}. Flat op parameters are accepted as a compatibility alias when the client transmits them; op and session_id remain top-level.
Inputs: op (required), params, session_id. Returns: object
csg_manageA
CSG authoring (create boolean shapes, set their operation).
Create CSG shapes (box, sphere, cylinder, torus, polygon) under a Node3D parent in the currently edited scene and set their boolean operation (union / intersection / subtraction) so geometry like holes, caves and tunnels can be carved directly in the editor. All write ops are undoable via EditorUndoRedoManager. Sibling CSG shapes under the same parent combine automatically; use a CSGCombiner3D parent for explicit grouping. Size, position and material live on the created node โ set them with node_set_property / material_manage after creation.
Ops: โข csg_create(parent_path, name="", shape="box", operation="union") Create a CSG shape under a Node3D parent (empty parent_path = scene root). shape: box | sphere | cylinder | torus | polygon. operation: union | intersection | subtraction. Returns: {path, name, shape, operation}
โข csg_set_operation(path, operation) Set the boolean operation of a CSG shape. operation: union | intersection | subtraction. Returns: {operation}
Canonical call shape: {"op": "<verb>", "params": {...}}. Flat op parameters are accepted as a compatibility alias when the client transmits them; op and session_id remain top-level.
Inputs: op (required), params, session_id. Returns: object
custom_manageA
List or invoke custom tools registered by third-party addons.
Active session only. Use op="list" to discover registered tools. op="invoke" requires params: tool_name (string); optional: params (dict, forwarded to the addon handler unvalidated โ shape per the tool's params_schema from op="list"). Inside batch_execute, address a custom tool as "custom_tool:" (deferred tools cannot run in batches). Some custom tools are also registered first-class as "custom_" with their own schema โ prefer those when present.
Canonical call shape: {"op": "<verb>", "params": {...}}. Flat op parameters are accepted as a compatibility alias when the client transmits them; op and session_id remain top-level.
Inputs: op (required), params, session_id. Returns: object
editor_manageA
Editor selection, performance monitors, quit, log clearing, game eval.
Resource forms (prefer for active-session reads): godot://editor/state, godot://selection/current, godot://performance
Ops: โข state() Editor version, project name, current scene, readiness, play state. โข selection_get() Currently selected node paths in the editor. โข selection_set(paths) Replace the selection with the given list of scene paths. โข monitors_get(monitors=None) Performance singleton values (FPS, memory, draw calls, etc.). Pass a list of monitor names to filter; None returns everything. โข quit() Gracefully quit the Godot editor on next frame. โข logs_clear(clear_debugger_errors=False) Clear the MCP log buffer. Returns cleared_count. Pass clear_debugger_errors=True to also clear the Debugger dock's visible Errors-tab rows (user-facing UI, so opt-in only); the response then includes debugger_errors_cleared. โข game_eval(code) Execute GDScript in the running game with return values. Uses 'await' so user code can await internally. Errors return fast and actionable: EVAL_COMPILE_ERROR for a syntax/parse error, EVAL_RUNTIME_ERROR (with the real message + line) for a runtime error; EVAL_GAME_NOT_READY if the game can't service evals โ still launching (retry once it's up), the _mcp_game_helper autoload is missing/disabled, its main loop is not advancing (focus the game), or its debugger session closed; EVAL_HUNG for a live game's genuine infinite loop / never-firing await; EVAL_RESULT_TOO_LARGE if the returned value serializes past the debugger channel's capacity (return a smaller slice).
Canonical call shape: {"op": "<verb>", "params": {...}}. Flat op parameters are accepted as a compatibility alias when the client transmits them; op and session_id remain top-level.
Inputs: op (required), params, session_id. Returns: object
editor_reload_pluginA
Reload the Godot editor plugin.
Disables and re-enables the plugin on the next frame. The response shape depends on whether this MCP server was spawned by the plugin or launched externally:
Plugin-managed (default install): returns a pre-flight ack
{status: "reload_initiated", transport_will_drop: true, old_session_id, guidance}immediately. The reload kills this server, so the WebSocket transport drops; reconnect and callsession_manage(op="list")to find the new session_id.Externally launched (e.g.
python -m godot_ai --transport streamable-http --port 8000 --reload): waits for the new session to register and returns{status: "reloaded", old_session_id, new_session_id}. If the old bridge disappears and no replacement registers within 90 seconds, raisesPLUGIN_DISCONNECTEDwithdata.reason == "reload_timeout"and recovery diagnostics.
Inputs: session_id. Returns: object
editor_screenshotA
Capture a screenshot of the Godot editor viewport or running game.
Picking a source: the default "viewport" captures the editor's 3D
viewport, which is empty if the edited scene has no Node3D anywhere in
the tree (or no scene is open). Those cases return EDITOR_NOT_READY
with error.data = {editor_state: "viewport_not_3d", scene_root_type}
and an actionable error.message โ switch to "cinematic" if the
scene has a Camera3D, or open a scene with 3D content.
Sources:
"viewport" (default): editor 3D viewport. Requires Node3D content in the edited scene (root or any descendant); see above for the no-3D-content / no-scene error shape.
"viewport_2d": editor 2D viewport. Use for 2D scenes. Not compatible with view_target/coverage/elevation/azimuth/fov.
"cinematic": render edited scene through its active Camera3D (no editor gizmos). Prefers a Camera3D marked
current; falls back to the first Camera3D found in a depth-first walk. NODE_NOT_FOUND only when the scene contains no Camera3D at all."game": running game's framebuffer (only when project is running). A backgrounded/minimized game window freezes its main loop; the capture then returns the last rendered frame with
stale_frame: trueand anotein the metadata โ focus the game window and retry for a current frame.GAME_HELPER_TIMEOUTmeans the game process never replied at all (nothing rendered yet, main thread blocked, or helper dead) โ focus the window and retry, or use game_command to confirm liveness.
include_image=True (default) returns an MCP ImageContent block.
view_target (comma-separated Node3D paths) reframes editor camera;
AABB metadata always returned. coverage=True with view_target
captures perspective + orthographic top-down references.
Inputs: fov, source, azimuth, coverage, +6 more.
editor_stateA
Get current Godot editor state: version, readiness, open scene, play state.
Resource form: godot://editor/state โ prefer for active-session reads.
Also reachable as editor_manage(op="state") (same handler) for clients
that prefer a single rolled-up tool.
Code-mode MCP adapters keep the server and tool names separate:
call('godot-ai', 'editor_state', {}). Never pass a server-prefixed
tool name such as godot-ai/get_editor_state; that is neither the
adapter's call signature nor a registered tool. For dedicated current-
scene data, use readResource('godot-ai', 'godot://scene/current').
Side effect: refreshes the server's session readiness cache from the
live editor reply. Useful as a recovery step after a write call is
rejected as EDITOR_NOT_READY (state=playing) when you already know
the game has stopped โ calling editor_state once syncs the cache
and the next write proceeds. Issue #262.
Response includes game_status for authoritative game liveness,
plus helper_live (status == "live") and session_active
(status not in {"not_live", "stopped"}) mirrored from the same fields
inside game_status. is_playing remains raw editor play-state;
use game_status.status for liveness decisions.
game_status.status="break" means the game process is parked in a
remote-debugger break (boot-time parse errors do this before the game
helper registers); it will not resume on its own โ call
project_manage(op="stop").
Inputs: session_id. Returns: object
filesystem_manageA
Project filesystem access via the Godot editor's EditorFileSystem.
Ops:
โข read_text(path)
Read a text file at a res:// path. Returns content, size,
line_count.
โข write_text(path, content="")
Create or overwrite a text file. Updates the editor filesystem
entry for that one file (single-file update, not a full scan).
Newly-created files include data.cleanup.rm for transient
smoke tests; overwrite omits the field.
โข reimport(paths)
Force-reimport the listed files via EditorFileSystem.update_file.
paths is a list of res:// paths.
Intended for imported assets such as textures, models, and audio.
Paths that are not imported resources (.gd scripts, .tscn,
hand-written .tres, or an asset the editor has not imported yet)
report under skipped_non_imported rather than reimported: their
filesystem entry is refreshed, but no import runs, so a success there is
not evidence that a script parsed or that diagnostics were produced. Use
script_patch/script_create to save a script and receive fresh
diagnostics, or scan for an asset awaiting its first import.
Returns reimported, skipped_non_imported, not_found and their
counts.
โข scan()
Force a full EditorFileSystem.scan() and wait for it to settle.
This is the headless equivalent of the editor regaining window focus:
write_text/script_create register single files but do NOT
rebuild the global class_name table, so a freshly-created
class_name MyThing extends Resource is invisible to
resource_manage/type references until a scan runs. Call this once
after adding class_name scripts when the editor isn't focused.
Single-flight (awaits any in-progress scan rather than stacking another).
Returns scan_completed and global_classes_registered_delta.
โข search(name="", type="", path="", offset=0, limit=100)
Find files by name, resource type, or path substring. At least one
filter must be set. Paginated.
Canonical call shape: {"op": "<verb>", "params": {...}}. Flat op parameters are accepted as a compatibility alias when the client transmits them; op and session_id remain top-level.
Inputs: op (required), params, session_id. Returns: object
game_manageA
Runtime game inspection and input simulation.
These ops target the running game process through Godot's EngineDebugger bridge. Start the project first with project_run and poll editor_state until game_capture_ready=true.
Ops:
get_scene_tree(depth=10, root_path="") Inspect the running scene tree. root_path accepts an absolute runtime path or a scene-relative path rooted at the current scene.
get_node_info(path, include_properties=True) Inspect one running node's metadata and optional property snapshot.
get_ui_elements(root_path="", include_hidden=False, include_disabled=True, max_depth=10) Inspect visible runtime Control nodes for UI testing. Includes path, type, text where present, disabled state, and rect metadata.
suspend() Suspend the running game through Godot's native debugger path.
resume() Resume a suspended game. Idempotent when it is already running.
next_frame() Advance exactly one process tick while suspended. The response reports verification and any Embedded Game View focus handoff. Runtime-control mutations also report path="embed_signal" or "direct_session"; the direct fallback works without embedding but cannot synchronize the Game View suspend button's visual pressed state.
debug_status() Probe suspend state and the game-helper process tick counter through the debugger capture, including while SceneTree processing is suspended.
input_key(key, pressed=True, echo=False) Send a key press/release to the running game.
input_mouse(event, position=None, button="left", pressed=True) Send a mouse motion or button event. event: "motion" | "button". position is a {x, y} object or [x, y] array; omit it to use the game's current cursor position. A present but malformed position is rejected rather than silently falling back to the cursor.
input_gamepad(device=0, control="button", index=0, pressed=True, value=0.0) Send a joypad button or axis event. control: "button" | "axis".
input_action(action, pressed=True, strength=1.0) Set a project action's pressed state directly in the running game.
input_sequence(steps, settle_frames=0) Apply a frame-timed action timeline in one call โ the frame-accurate, multi-step form of input_action. Each step is {at_frame, action, pressed=True, strength=1.0}; the game applies each step's action on its scheduled frame, awaits settle_frames more, then replies once. Use this instead of separate input_action calls whenever timing matters (jump arcs, combos, walk-into-trigger): per-call network latency makes hitting a target frame impossible otherwise. Steps must be ordered by non-decreasing at_frame; frames (not ms) are the timing basis. Action-based input is focus-independent, so it works on a backgrounded game window. Cannot run inside batch_execute.
input_state(actions=None) Read current action pressed states. Empty actions = all project actions.
Canonical call shape: {"op": "<verb>", "params": {...}}. Flat op parameters are accepted as a compatibility alias when the client transmits them; op and session_id remain top-level.
Inputs: op (required), params, session_id. Returns: object
gridmap_manageA
GridMap authoring (set items, fill 3D regions, clear, read cells + library items).
All operations target GridMap nodes in the currently edited scene by scene-relative path (e.g. "/Main/Terrain"). All write ops are undoable via EditorUndoRedoManager.
item is the item id from the GridMap's MeshLibrary. Use gridmap_list_library_items to discover valid ids and names before placing cells (the 3D analogue of tileset atlas inspection). orientation is the GridMap baked rotation index (0..24).
Ops: โข gridmap_set_item(path, item, map_x, map_y, map_z, orientation=0) Set a single cell item at (map_x, map_y, map_z). item=-1 erases. Returns: {map_x, map_y, map_z, item, orientation}
โข gridmap_fill(path, item, rect_x, rect_y, rect_z, rect_w, rect_h, rect_d, orientation=0) Fill a rect_w ร rect_h ร rect_d region starting at (rect_x, rect_y, rect_z) with one item in a single undo action. Returns: {cells_filled, rect: {x, y, z, w, h, d}}
โข gridmap_clear(path) Remove all cells from the GridMap. Returns: {cleared: true}
โข gridmap_get_used_cells(path) Return all used cell coordinates. Returns: {cells: [{x, y, z}, ...], count: int}
โข gridmap_list_library_items(path) List the MeshLibrary items available to the GridMap. Returns: {library, items: [{item, name, mesh}...], count: int}
Canonical call shape: {"op": "<verb>", "params": {...}}. Flat op parameters are accepted as a compatibility alias when the client transmits them; op and session_id remain top-level.
Inputs: op (required), params, session_id. Returns: object
input_map_manageA
InputMap actions and bindings (keyboard, mouse, gamepad). Persisted to
project.godot.
Resource form: godot://input_map โ prefer for active-session reads.
Ops:
โข list(include_builtin=False)
List input actions and their bound events. By default only
user-authored actions (those persisted in project.godot under
input/<name>) are returned; pass include_builtin=True to
also surface Godot's ui_* and editor-runtime actions
(spatial_editor/*, etc.). The is_builtin field on each
entry is true for any action not authored by the user.
โข add_action(action, deadzone=0.5)
Create a new empty input action. deadzone must be in
[0.0, 1.0] โ Godot uses it as the analog-stick dead-zone
threshold; values outside this range are rejected with
VALUE_OUT_OF_RANGE. Typical values are 0.2-0.5; leave the
default 0.5 unless you have a reason. Not a key-repeat delay.
โข ensure_action(action, deadzone=0.5)
Idempotently create or persist an input action. If the action exists
in live InputMap or in project.godot, the existing state is preserved.
โข remove_action(action)
Remove an action and all its event bindings. Also removes actions
persisted in project.godot but not loaded in the live InputMap
(loaded_in_input_map: false in list), e.g. actions created
by a previous editor session.
โข bind_event(action, event_type, keycode="", ctrl=False, alt=False,
shift=False, meta=False, button=None, axis=None,
axis_value=1.0)
Bind a key/mouse/gamepad event to an action. The action must
already exist (call add_action first). event_type is
"key" | "mouse_button" | "joy_button" |
"joy_axis".
- key: keycode is a Godot keycode name string like
"A", "Space", "Enter", "Escape", "F1",
"Left" โ not an integer and not KEY_*. Modifier
booleans ctrl / alt / shift / meta optional.
- mouse_button: button is an int โ 1=left, 2=right,
3=middle, 4=wheel up, 5=wheel down.
- joy_button: button is the JoyButton index
(e.g. 0=A/Cross, 1=B/Circle).
- joy_axis: axis is the JoyAxis index and
axis_value is the direction/value, usually -1.0 or 1.0.
โข ensure_binding(action, event_type, ...)
Idempotently ensure the action exists and has the requested binding.
Canonical call shape: {"op": "<verb>", "params": {...}}. Flat op parameters are accepted as a compatibility alias when the client transmits them; op and session_id remain top-level.
Inputs: op (required), params, session_id. Returns: object
logs_readA
Read recent log lines from the Godot editor, plugin, or running game.
Resource form: godot://logs/recent โ prefer for active-session reads.
Sources:
"plugin" (default): MCP plugin recv/send/event traffic. Buffer 500.
"game": stdout/stderr/push_error/push_warning from playing game via
_mcp_game_helperautoload. Buffer 2000, with lines retained across runs and tagged by run_id. Default reads return current-run lines only; passsince_run_idfrom an earlier response to read that prior run. Entries: {source, level, text, run_id}; response carries run_id, current_run_id, game_status, helper_live, session_active, dropped_count, stale_run_id. helper_live and session_active mirror the same fields inside game_status; is_running is retained as a compatibility alias of session_active. Boot-time parse/load errors fire before the game helper's logger attaches, so they are NEVER in this buffer; when editor-side errors were recorded during the current run the response addseditor_errors_countandeditor_errors_hintpointing at source="editor" โ treat a clean game log carrying that hint as a run that lost scripts, not a clean launch."editor": editor-process script errors and the Debugger dock's visible Errors-tab rows โ parse errors, GDScript reload warnings, @tool/EditorPlugin runtime errors, push_error/push_warning. Logger-backed entries and Errors-tab rows are read from the editor UI when available. Use when the editor Output or Debugger Errors panel shows red/yellow rows but other sources turned up nothing. Buffer 500 for logger-backed entries; Debugger rows are live UI state. Entries: {source, level, text, path, line, function}. Filtered to .gd/.cs in the user project for Logger-backed entries; addons/godot_ai/ dropped. Logger entries fired before plugin enable are not captured.
"all": plugin โ editor โ game lines (with source per entry).
Tail pattern: for game logs, poll the current run with offset=N and
keep the returned run_id. current_run_id identifies the active run;
run_id identifies the run being read. Passing
since_run_id=old_run_id reads retained lines for that prior run, and
stale_run_id: true means the requested run is not the current run.
For editor logs, read once to capture
next_cursor and pass it back as since_cursor on later calls.
since_cursor reads Logger-backed editor entries only; live Debugger
Errors-tab rows are included in regular source="editor" reads but do
not have stable cursors. When since_cursor is set, it supersedes
offset. truncated: true means older entries fell out of the
ring before the poll; continue from the returned next_cursor and
treat oldest_cursor as the earliest retained sequence.
Set include_details=True for Errors-tab style metadata on game/editor
entries: original code/rationale, error type, resolved source, and
stack frames. Default false preserves compact responses.
Inputs: count, offset, source, session_id, +3 more. Returns: object
material_manageA
Material authoring (StandardMaterial3D, ORMMaterial3D, ShaderMaterial, CanvasItemMaterial). Albedo, metallic/roughness, emission, transparency, shader uniforms.
Resource form: godot://materials โ prefer for active-session reads.
Ops:
โข create(path, type="standard", shader_path="", overwrite=False)
Create + save a material .tres at a res:// path. type:
"standard" | "orm" | "canvas_item" | "shader". For "shader",
shader_path points to the .gdshader.
โข set_param(path, param, value)
Set a built-in property on a .tres material. Enum-valued params
accept names ("alpha" -> TRANSPARENCY_ALPHA). Color/Vector dicts.
Texture properties accept res:// paths.
โข set_shader_param(path, param, value)
Set a shader uniform on a ShaderMaterial.
โข get(path)
Inspect a material (type, params, uniforms, current values).
โข list(root="res://", type="")
List materials under root, optional type filter.
โข assign(node_path, resource_path="", slot="override", create_if_missing=False,
type="standard")
Assign a material to a node slot. Slots: "override" |
"surface_" | "canvas" | "process". When create_if_missing=True
and no resource_path, makes an inline material of type.
โข apply_to_node(node_path, type="standard", params=None, slot="override",
save_to="", overwrite=False)
High-level: build + set params + assign in one undo.
save_to optionally persists to disk; errors if the file already
exists unless overwrite=True.
โข apply_preset(preset, path="", node_path="", overrides=None)
Curated looks: metal, glass, emissive, unlit, matte, ceramic.
path saves to disk; node_path assigns to a node; overrides merge.
Canonical call shape: {"op": "<verb>", "params": {...}}. Flat op parameters are accepted as a compatibility alias when the client transmits them; op and session_id remain top-level.
Inputs: op (required), params, session_id. Returns: object
node_createA
Create (spawn) a new node in the scene tree.
Creates a node of the given type and adds it to the parent, or
instantiates a PackedScene from scene_path. type and scene_path
are mutually exclusive โ when scene_path is given, type is ignored.
Inputs: name, type, scene_file, scene_path, +2 more. Returns: object
node_findA
Find nodes in the scene tree by name, type, or group.
At least one filter must be provided. Filters AND together. Paginated.
Inputs: name, type, group, limit, +2 more. Returns: object
node_get_propertiesA
Get properties of a node.
Resource form: godot://node/{path}/properties โ prefer for
active-session reads (returns the full property set).
The default returns every editor-visible property, which can be
50-150 entries. Pass fields to return only the properties you
need โ a large response-size cut on this hot read. The response
always carries total_count (all editor-visible properties)
alongside count (returned): an unfiltered call returns the full
set, so count == total_count; only the fields filter can
make count smaller. Requested names that match no
editor-visible property are listed in unknown_fields, so a
nonexistent name is distinguishable from a property that exists
with a null value.
Null-valued properties are included: an unset object/resource slot
(script on an unscripted node, an empty mesh or
material, โฆ) returns "value": null with its declared type.
An attached script serializes to its res:// path; built-in
scripts (no resource path) fall back to their string
representation.
Inputs: path (required), fields, session_id. Returns: object
node_manageA
Node tree manipulation (delete, duplicate, rename, reorder, reparent, groups, hierarchy reads).
Resource forms (prefer for active-session reads): godot://node/{path}/properties, godot://node/{path}/children, godot://node/{path}/groups
Ops: โข get_children(path) Direct children of a node (name, type, path each). โข get_groups(path) Group names the node belongs to. โข delete(path, scene_file="") Remove the node. Cannot delete scene root. Undoable. โข duplicate(path, name="", scene_file="") Deep-copy a node + children as a sibling. Cannot duplicate scene root. โข rename(path, new_name, scene_file="") Rename a node. Sibling-name collision and "/" / ":" / "@" rules apply. โข move(path, index, scene_file="") Reorder among siblings. Index 0 = first. โข reparent(path, new_parent, scene_file="") Move under a new parent. Children preserved. Cannot move into descendants. โข add_to_group(path, group, scene_file="") Add the node to a group. โข remove_from_group(path, group, scene_file="") Remove the node from a group. โข rotate(path, degrees, axis="y", relative=false, scene_file="") Rotate a 2D or 3D node by degrees. Undoable. โข scale(path, scale, relative=false, scene_file="") Scale a 2D or 3D node or Control. Undoable. โข translate(path, offset, relative=true, scene_file="") Move / offset a node position. Undoable.
All write ops accept the optional scene_file guard โ if non-empty, the
mutation fails with EDITED_SCENE_MISMATCH when the editor's current scene
doesn't match.
Canonical call shape: {"op": "<verb>", "params": {...}}. Flat op parameters are accepted as a compatibility alias when the client transmits them; op and session_id remain top-level.
Inputs: op (required), params, session_id. Returns: object
node_set_propertyA
Set a property on a node.
Verify the property name first โ call node_get_properties (or read
godot://node/{path}/properties) to confirm the exact name and type
before writing. Guessing common Godot names often fails with
PROPERTY_NOT_ON_CLASS because Godot's actual properties differ from
intuition (e.g. Camera3D uses fov/current, not field_of_view;
Sprite2D uses texture, not image; Node3D uses
position/rotation/scale, not transform.origin).
Coerces value to the property's type:
Vector2/Vector3: dict with x/y/z keys.
Color: dict {r,g,b,a} or hex string ("#ff0000").
NodePath: string ("../Other/Node").
Resource: res:// path string (loads + assigns); null/"" clears.
{"__class__": "BoxMesh", ...}creates a built-in resource owned by this property. After scene_save it is serialized in-place as a[sub_resource]inside the .tscn; it is not a reusable .tres. For sharing, first callresource_manage(op="create", params={"type": "BoxMesh", "properties": {...}, "resource_path": "res://meshes/box.tres"}), then pass that res:// path here (or use resource_manage(op="assign")).StringName: plain string. Array/Dictionary: JSON list/object.
Inputs: path (required), value (required), property (required), scene_file, +1 more. Returns: object
particle_manageA
Particle systems (GPUParticles2D/3D, CPUParticles2D/3D). All write ops create the node + sub-resources (ProcessMaterial, default QuadMesh draw pass) in a single undo action.
Ops: โข create(parent_path, name="Particles", type="gpu_3d") Create an emitter. type: "gpu_3d" | "gpu_2d" | "cpu_3d" | "cpu_2d". For GPU emitters, auto-creates ProcessMaterial; for gpu_3d, also a default QuadMesh draw pass. โข set_main(node_path, properties) Node-level props: amount, lifetime, one_shot, explosiveness, preprocess, speed_scale, randomness, fixed_fps, emitting, local_coords, interp_to_end. โข set_process(node_path, properties) Behavior props (auto-creates ProcessMaterial for GPU). Emission shape, velocity, gravity, color_ramp, scale_curve, turbulence. See full property list in the Godot reference. GPU gravity is a Vector3 โ pass {x, y, z} or [x, y, z], including for gpu_2d (the shared ProcessMaterial is 3D; z is ignored in 2D). โข set_draw_pass(node_path, pass_=1, mesh="", texture="", material="") What gets drawn per particle. GPU 3D: mesh in draw_pass_N + optional material override. GPU 2D / CPU 2D: texture. CPU 3D: mesh. โข restart(node_path) Restart emission. Runtime-only, not undoable. โข get(node_path) Inspect main props, process material, draw passes. โข apply_preset(parent_path, name, preset, type="gpu_3d", overrides=None) Curated effects: fire, smoke, spark_burst, magic_swirl, rain, explosion, lightning. One-shot presets re-trigger via restart. overrides = {"main": {...}, "process": {...}, "draw": {...}}; bare keys are auto-routed to main (amount, lifetime, one_shot, ...) or process โ draw keys must be nested under "draw". draw configures the gpu_3d draw-pass StandardMaterial3D (blend_mode, albedo_color, emission, ...); on gpu_2d only draw.texture (res:// path) applies; cpu_* types reject draw overrides. Unknown or malformed override keys return INVALID_PARAMS (never silently dropped); response reports applied_main / applied_process / applied_draw. GPU gravity requires {x, y, z} (or [x, y, z]) even for gpu_2d.
Canonical call shape: {"op": "<verb>", "params": {...}}. Flat op parameters are accepted as a compatibility alias when the client transmits them; op and session_id remain top-level.
Inputs: op (required), params, session_id. Returns: object
project_manageA
Project run/stop and project.godot settings.
Resource form: godot://project/info and godot://project/settings
โ prefer for active-session reads.
Ops:
โข stop()
Stop the running project (game). Takes no params โ call as
project_manage(op="stop") or with params={}. Idempotent:
succeeds with was_running=false if the project isn't running.
Do NOT pass extra fields like force or reason inside
params โ only the registered keys are accepted (here, none).
For multi-editor setups, pass session_id as a sibling of
op/params, not inside params.
โข settings_get(key)
Read a ProjectSettings key (e.g. "application/config/name").
โข settings_set(key, value)
Write a ProjectSettings key and persist to project.godot.
Refuses the startup-execution keys (autoload/*,
editor_plugins/*, application/run/main_scene,
editor/run/main_run_args, editor/script/templates_search_path);
use set_main_scene / autoload_manage(op="add") for the two
that have a validated route.
โข set_main_scene(path)
Set the project's main scene โ the scene project_run(mode="main")
boots and the engine loads at startup. Writes
application/run/main_scene and persists to project.godot. path
must be a res:// scene inside the project that already exists and
loads as a PackedScene, so a scaffolded project can be made runnable
without opening the generic startup-execution surface.
Canonical call shape: {"op": "<verb>", "params": {...}}. Flat op parameters are accepted as a compatibility alias when the client transmits them; op and session_id remain top-level.
Inputs: op (required), params, session_id. Returns: object
project_runA
Run (play) the Godot project from the editor.
Modes:
"main": Run the project's main scene (default).
"current": Run the currently open scene.
"custom": Run a specific scene (requires
scene).
Idempotent: if the project is already running, returns success with
data.was_already_running=true (no scene switch). To switch scenes,
call project_manage(op="stop") first, then project_run again.
After starting playback, waits briefly for the Godot AI game helper to
check in. The response includes game_status, helper_live
(status == "live"), session_active (status not in {"not_live",
"stopped"}), and any recent_errors observed during the run window.
The top-level booleans mirror the same fields inside game_status.
game_status.status="not_live" means playback launched but the game
did not become live before the helper-ready window elapsed;
"no_helper" means the project has no _mcp_game_helper autoload, as
with some headless/custom-main-loop setups (helper_live=false,
session_active=true); "stopped" means playback stopped or never
became active before liveness could be confirmed (helper_live=false,
session_active=false); "break" means the game process is parked in
a remote-debugger break โ during boot this is a GDScript parse/load
error that froze the game before the helper could register, and the
response names the failing script when captured
(game_status.break = {reason, can_debug, pre_live}). A game at
a break cannot continue on its own: call project_manage(op="stop"),
fix the error, and relaunch. Poll editor_state to see late
transitions.
Inputs: mode, scene, autosave, session_id. Returns: object
resource_manageA
Resource (asset) search, inspection, assignment, and creation. Covers generic Resource subclasses plus specialized authoring (Curve, Environment, physics shapes, gradient/noise textures).
Ops: โข search(type="", path="", offset=0, limit=100) Search for resources by type or path. Type matching includes subclasses. At least one filter required. Paginated. โข load(path) Inspect a .tres / .res โ returns type and editor-visible properties. โข assign(path, property, resource_path) Load and assign a resource to a node property. Undoable. โข get_info(type) Introspect a Resource class โ properties, parent, abstract flag, concrete_subclasses (for abstract bases). Read-only. โข create(type, properties=None, path="", property="", resource_path="", overwrite=False) Instantiate a Resource subclass. Either path+property (assign to a node, undoable) or resource_path (save to .tres). For specific families (Curve, Environment, etc.) prefer the dedicated ops. โข curve_set_points(points, path="", property="", resource_path="") Replace all points on a Curve / Curve2D / Curve3D. Auto-creates the curve resource if the slot is empty (curve_created flag). โข environment_create(path="", preset="default", properties=None, sky=None, resource_path="", overwrite=False) Build Environment + Sky chain. Presets: default | clear | sunset | night | fog. sky may be bool or a procedural sky dict such as {"sky_material": "procedural", "sky_top_color": "#0f172a"}. Either assign to a WorldEnvironment node or save .tres. โข physics_shape_autofit(path, source_path="", shape_type="") Size a CollisionShape2D/3D to a nearby visual's bounds. Searches direct siblings then parent-siblings (handles nested BodyโCollision layouts). Ambiguous matches return candidate paths in error.data.candidates. Auto-creates the concrete Shape subclass if needed. shape_type accepts either the short form ("box", "sphere", "capsule", "cylinder" for 3D; "rectangle", "circle", "capsule" for 2D) or the matching Godot class name ("BoxShape3D", "RectangleShape2D", etc.). โข physics_shape_generate(paths, shape_type="box", body_type="static", scene_file="") Generate a StaticBody3D or Area3D sibling (named Collider) with a CollisionShape3D for every MeshInstance3D path. Shapes are fitted in body-local space; a mesh that already has a collider sibling, a duplicate path, or a scene-root mesh is refused before anything is written. shape_type: box | sphere | capsule | cylinder (or the class name); a sphere/capsule/cylinder under a non-uniformly scaled parent is refused. body_type: static | area. scene_file pins the request to that edited scene. Up to 1024 paths are processed in bounded work across editor frames; inside batch_execute at most 16. The bulk write is one undo action. Returns: {created: [{mesh_path, body_path, shape_path, shape_type, body_type}], undoable: true}. โข gradient_texture_create(stops, width=256, height=1, fill="linear", path="", property="", resource_path="", overwrite=False) Build GradientTexture2D from color stops. fill: linear | radial | square. โข noise_texture_create(noise_type="simplex_smooth", width=512, height=512, frequency=0.01, seed=0, fractal_octaves=0, path="", property="", resource_path="", overwrite=False) Build NoiseTexture2D wrapping FastNoiseLite. Noise types: simplex | simplex_smooth | perlin | cellular | value | value_cubic.
Canonical call shape: {"op": "<verb>", "params": {...}}. Flat op parameters are accepted as a compatibility alias when the client transmits them; op and session_id remain top-level.
Inputs: op (required), params, session_id. Returns: object
scene_get_hierarchyA
Get the scene tree hierarchy from the open scene.
Returns a paginated flat list of nodes with name, type, path, and child count. Walks up to the specified depth.
Resource form: godot://scene/hierarchy โ prefer for active-session
reads.
Inputs: depth, limit, offset, session_id. Returns: object
scene_manageA
Scene authoring (create, save_as, list open roots).
Resource form: godot://scene/current and godot://scene/hierarchy
โ prefer for active-session reads.
Ops: โข create(path, root_type="Node3D", root_name="") Create the initial .tscn with the given root and open it. root_name defaults to filename basename when empty. This initial root is written immediately, but later node_create/node_set_property mutations remain in editor memory until scene_save or save_as is called. โข save_as(path) Save the currently edited scene to a new file path. โข get_roots() List scenes currently open in the editor; flag the edited one.
Canonical call shape: {"op": "<verb>", "params": {...}}. Flat op parameters are accepted as a compatibility alias when the client transmits them; op and session_id remain top-level.
Inputs: op (required), params, session_id. Returns: object
scene_openA
Open an existing scene file (.tscn) in the editor.
If path is already the currently edited scene this is a no-op
โ the in-memory state (including any unsaved MCP mutations) is
preserved. Pass force_reload=True when the file on disk is the
authority and the editor should discard the open in-memory copy and
re-read the scene from disk.
The reply is sent only after the editor has actually switched to the
requested scene (switched: true), so follow-up writes are safe
immediately. switched: false with settle: "timeout" means the
switch had not landed within the wait window. In synchronous contexts
(e.g. inside batch_execute) the reply returns immediately with
switched: false and settle: "not_waited". In both of those
cases, re-check editor_state before issuing follow-up writes.
Inputs: path (required), session_id, force_reload. Returns: object
scene_saveA
Save the currently edited scene to disk.
Node and property mutation tools change the editor's in-memory scene; call this explicitly to persist those mutations to the existing path.
Inputs: session_id. Returns: object
script_attachA
Attach a script to a node in the scene tree.
Replaces any existing script on the node. Undoable.
Inputs: path (required), script_path (required), session_id. Returns: object
script_createA
Create a new GDScript source file (.gd) on disk.
Writes content to a .gd file in the project. Overwrites if it exists.
Triggers a filesystem scan. New files include data.cleanup.rm
listing the .gd + .gd.uid sidecar; overwrite omits it.
Inputs: path (required), content, session_id. Returns: object
script_manageA
Script (.gd) reading, detachment, and outline.
Resource form: godot://script/{path} โ prefer for active-session reads.
Ops: โข read(path) Read full source, line count, file size. โข detach(path) Remove the currently attached script from a node. Undoable. โข find_symbols(path) Outline a .gd โ class_name, extends, functions, signals, @export vars.
Canonical call shape: {"op": "<verb>", "params": {...}}. Flat op parameters are accepted as a compatibility alias when the client transmits them; op and session_id remain top-level.
Inputs: op (required), params, session_id. Returns: object
script_patchA
Anchor-based string-replace edit on a .gd file.
Finds an exact old_text and replaces with new_text. Fails
on multiple matches unless replace_all=True; fails on zero matches.
Exact byte match (whitespace significant). Triggers filesystem scan and
refreshes an already-loaded GDScript in place so the next call runs the
new code (response reloaded=true; otherwise reload_reason says why).
Not undoable via Ctrl+Z.
Inputs: path (required), new_text (required), old_text (required), session_id, +1 more. Returns: object
session_activateA
Set the active Godot editor session for subsequent tool calls.
Accepts either an exact session_id or a substring hint matched against the session's short name (project folder basename), project_path, or session_id. An exact id match always wins; a substring must resolve to exactly one session or the tool returns an error listing the candidates.
Inputs: session_id (required). Returns: object
session_manageA
Session listing.
Resource form: godot://sessions โ prefer for resource-aware clients.
Ops:
โข list()
List every connected Godot editor with metadata: session_id, short
name, godot_version, project_path, plugin_version, server_version,
editor_pid, server_launch_mode, current_scene, play_state, readiness,
connected_at, last_seen, is_active. The response also carries the
server-global exclude_domains (tool domains not registered on
this server via --exclude-domains).
Canonical call shape: {"op": "<verb>", "params": {...}}. Flat op parameters are accepted as a compatibility alias when the client transmits them; op and session_id remain top-level.
Inputs: op (required), params, session_id. Returns: object
signal_manageA
Signals (Godot's event/observer mechanism) โ list, connect, disconnect.
Ops:
โข list(path, include_editor=False)
List all signals on the node and their current connections (built-in
and custom). By default editor-internal connections (the
SceneTreeEditor dock and friends) are filtered out โ pass
include_editor=True to surface them. The response carries
editor_connection_count so an agent can tell how many were hidden.
โข connect(path, signal, target, method)
Connect a signal from path to a method on the target node.
Undoable.
โข disconnect(path, signal, target, method)
Remove an existing connection. Undoable.
Canonical call shape: {"op": "<verb>", "params": {...}}. Flat op parameters are accepted as a compatibility alias when the client transmits them; op and session_id remain top-level.
Inputs: op (required), params, session_id. Returns: object
test_manageA
Test result inspection (re-fetches the most recent test_run payload).
Resource form: godot://test/results โ prefer for active-session reads.
Ops: โข results_get(verbose=False) Same shape as test_run โ full results from the last run, no re-execution. verbose=True includes every individual test result.
Canonical call shape: {"op": "<verb>", "params": {...}}. Flat op parameters are accepted as a compatibility alias when the client transmits them; op and session_id remain top-level.
Inputs: op (required), params, session_id. Returns: object
test_runA
Run GDScript test suites inside the connected Godot editor.
Discovers test_*.gd in res://tests/, instantiates them, and runs
all test_* methods. Returns a compact summary by default (counts,
suite names, duration) plus failures only. verbose=True includes
every individual test result (each with per-test duration_ms).
Preloaded GDScript dependencies may remain stale after source edits; the response includes cache_warning. Restart the editor before using a rerun to validate dependency edits. ResourceLoader cache modes alone do not refresh the GDScript preload cache.
The whole run has a 300s budget; the plugin aborts between tests shortly before it expires and returns TEST_RUN_TIMEOUT with the partial summary (full partials via test_manage(op="results_get")). Long suites are safe โ the editor services the MCP transport between tests โ but one single test blocking the main thread for 20s+ can still drop the session. Not allowed inside batch_execute.
The response includes edited_scene (the scene currently open in
the editor). Many suites assume the project's main scene is open; if
it is not and there are failures, the response also carries a
scene_warning โ open the main scene (scene_open) and re-run
before treating those failures as real.
Inputs: suite, verbose, test_name, session_id, +1 more. Returns: object
theme_manageA
Theme authoring (Godot's stylesheet-like resource for Controls). Cascades down a Control subtree when assigned via theme_apply.
Ops (pass via op="..." plus a params dict): โข create(path, overwrite=False) Create a new empty Theme .tres at a res:// path. โข set_color(theme_path, class_name, name, value) Set a color slot. value: "#rrggbb"/"#rrggbbaa", named, or {"r","g","b","a"}. โข set_constant(theme_path, class_name, name, value) Set an integer constant (separation, margin, padding). โข set_font_size(theme_path, class_name, name, value) Set a font_size slot in pixels. โข set_stylebox_flat(theme_path, class_name, name, bg_color?, border_color?, border?, corners?, margins?, shadow?, anti_aliasing?) Compose a StyleBoxFlat (panels, button states, line edits). border/corners/margins/shadow each accept "all" + per-side keys. โข apply(node_path, theme_path="") Assign the theme to a Control (cascades to descendants). Empty theme_path clears.
All ops accept session_id on the wrapper to target a specific editor.
Canonical call shape: {"op": "<verb>", "params": {...}}. Flat op parameters are accepted as a compatibility alias when the client transmits them; op and session_id remain top-level.
Inputs: op (required), params, session_id. Returns: object
tilemap_manageA
TileMap / TileMapLayer authoring (set tiles, fill rects, clear, read cells).
All operations target TileMapLayer nodes in the currently edited scene by scene-relative path (e.g. "/LavaLake20x20/Ground"). All write ops are undoable via EditorUndoRedoManager.
source_id is the TileSet source index. atlas_col/atlas_row are the atlas coordinates of the tile within that source. For full-tile animated sources (lava, water, sewage) use atlas_col=0, atlas_row=0.
IMPORTANT โ Source-ID remapping in specialized .tres files: When a layer uses a specialized .tres (e.g. volcano_animated.tres), Source-IDs are re-numbered from 0. Example: volcano lava is Source 8 in the main volcano.tres but Source 0 in volcano_animated.tres. Always use the remapped ID when the TileMapLayer references a specialized .tres, not the original ID from the main .tres.
Ops: โข tilemap_set_cell(path, source_id, atlas_col, atlas_row, map_x, map_y) Set a single tile at (map_x, map_y). Returns: {map_x, map_y, source_id, atlas_col, atlas_row}
โข tilemap_set_cells_rect(path, source_id, atlas_col, atlas_row, rect_x, rect_y, rect_w, rect_h) Fill a rect_w ร rect_h region starting at (rect_x, rect_y) with one tile type in a single undo action. Returns: {cells_filled, rect: {x, y, w, h}}
โข tilemap_clear(path) Remove all tiles from the layer. Returns: {cleared: true}
โข tilemap_get_cells(path) Return all used cell coordinates. Returns: {cells: [{x, y}, ...], count: int}
โข tilemap_place_tile(path, source_id, atlas_col, atlas_row, map_x, map_y, rotation_degrees=0, flip_h=false, flip_v=false, alternative_tile=-1) Place a tile with rotation and flip flags. Returns: {map_x, map_y, source_id, atlas_col, atlas_row, alternative_tile, rotation_degrees, flip_h, flip_v}
โข tilemap_rotate_cell(path, map_x, map_y, degrees=90) Rotate an existing tile cell at (map_x, map_y) clockwise by degrees (90, 180, 270). Returns: {map_x, map_y, degrees, old_alternative, new_alternative}
โข tilemap_flip_cell(path, map_x, map_y, flip_h=false, flip_v=false) Flip an existing tile cell at (map_x, map_y) horizontally and/or vertically. Returns: {map_x, map_y, flip_h_applied, flip_v_applied, new_alternative}
โข tilemap_erase_cell(path, map_x, map_y) Erase a single tile cell at (map_x, map_y). Returns: {map_x, map_y, erased}
โข tilemap_get_cell(path, map_x, map_y) Get detailed information of a tile cell. Returns: {has_tile, map_x, map_y, source_id, atlas_col, atlas_row, alternative_tile, flip_h, flip_v, transpose}
Canonical call shape: {"op": "<verb>", "params": {...}}. Flat op parameters are accepted as a compatibility alias when the client transmits them; op and session_id remain top-level.
Inputs: op (required), params, session_id. Returns: object
tileset_manageA
TileSet management โ atlas inspection tools.
Ops: โข tileset_get_atlas_tiles(tileset_path, source_id) Return all occupied atlas tile positions for one source in a TileSet. Read-only โ does not modify any resource or project file.
tileset_path: res:// path to the .tres TileSet resource (required)
source_id: raw TileSet source id of the TileSetAtlasSource to query (required, โฅ 0)
Returns:
{"tiles": [{"col": int, "row": int}, ...], "count": int}
Error codes (passed through from GDScript handler):
MISSING_REQUIRED_PARAM โ tileset_path empty or source_id absent
RESOURCE_NOT_FOUND โ tileset_path does not exist on disk
WRONG_TYPE โ not a TileSet, or source is not a TileSetAtlasSource
VALUE_OUT_OF_RANGE โ source_id does not exist in this TileSetโข tileset_get_atlas_image(tileset_path, source_id, max_size=0) Return the atlas sprite-sheet texture of a TileSetAtlasSource as a Base64-encoded PNG image. Read-only โ reads the texture directly from the resource without any UI interaction.
tileset_path: res:// path to the .tres TileSet resource (required)
source_id: raw TileSet source id of the TileSetAtlasSource to query (required, โฅ 0)
max_size: optional int; if > 0, scale the image so its longest
edge is at most max_size pixels (default 0 = full res)
Returns:
{"image_base64": str, "width": int, "height": int,
"original_width": int, "original_height": int, "format": "png"}
Error codes (passed through from GDScript handler):
MISSING_REQUIRED_PARAM โ tileset_path empty or source_id absent
RESOURCE_NOT_FOUND โ tileset_path does not exist on disk
WRONG_TYPE โ not a TileSet, source not a TileSetAtlasSource,
or source has no texture assigned
VALUE_OUT_OF_RANGE โ source_id does not exist in this TileSetโข Atlas image workflow: To visually inspect what tiles look like, use tileset_get_atlas_image instead of editor screenshots. It reads the texture directly from the resource โ no UI interaction or editor state required.
Canonical call shape: {"op": "<verb>", "params": {...}}. Flat op parameters are accepted as a compatibility alias when the client transmits them; op and session_id remain top-level.
Inputs: op (required), params, session_id. Returns: object
ui_manageA
UI / Control authoring (HUD, menus, layouts, vector decoration).
Ops:
โข set_anchor_preset(path, preset, resize_mode="minsize", margin=0)
Apply a Control layout preset. preset: top_left | top_right |
bottom_left | bottom_right | center_left | center_top | center_right |
center_bottom | center | left_wide | top_wide | right_wide |
bottom_wide | vcenter_wide | hcenter_wide | full_rect.
resize_mode: minsize | keep_width | keep_height | keep_size.
Target must be a Control. CanvasLayer is the canonical HUD parent
but is not a Control โ put a Control child under the CanvasLayer and
apply the preset to that overlay.
โข set_text(path, text)
Set text on a Label/Button/LineEdit/TextEdit/RichTextLabel.
โข build_layout(tree, parent_path="")
Atomically build a UI subtree from a nested spec
({type, name?, properties?, anchor_preset?, anchor_margin?, theme?,
children?}). Validates everything before mutating.
properties is direct node properties only. Theme constants like
container spacing live under theme_override_constants/<name> โ
e.g. {"theme_override_constants/separation": 8} on a
VBoxContainer, not {"separation": 8} (which errors).
theme and anchor_preset require a Control / Window โ for a HUD,
nest a Control under a CanvasLayer and apply them to the Control
child, not the layer itself.
โข draw_recipe(path, ops, clear_existing=True)
Attach a declarative list of vector _draw() ops to a Control โ
radar sweeps, gauges, corner brackets, crosshairs, waveforms.
Op kinds: line | rect | arc | circle | polyline | polygon | string.
Canonical call shape: {"op": "<verb>", "params": {...}}. Flat op parameters are accepted as a compatibility alias when the client transmits them; op and session_id remain top-level.
Inputs: op (required), params, session_id. Returns: object
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
Loading tool schema changelogโฆ
TDQS
Scored across 46 tools
Most tools target clearly separate Godot subsystems (nodes, scenes, scripts, materials, tilemaps, etc.), so an agent can usually pick correctly. However, there is noticeable overlap: editor_state duplicates editor_manage(op='state'), scene_get_hierarchy overlaps with scene_manage/resource forms, node_get_properties overlaps with node_manage reads, and generic resource_manage overlaps specialized tools like material_manage and theme_manage.
The names are consistently snake_case with a domain-first pattern, mostly domain_manage for grouped operations and domain_action for single-purpose tools. Minor deviations exist, such as editor_state, logs_read, editor_reload_plugin, scene_get_hierarchy, and project_run, but they remain readable and predictable.
With 46 top-level tools, the set is heavy for an MCP server even though Godot is a broad engine. While many tools are multi-op managers that consolidate related actions, the sheer number of top-level entries increases selection burden and exceeds the range where a tool set typically stays well-scoped.
The surface covers an impressive range of Godot editor workflows: scene/node editing, scripts, resources, materials, animations, UI, tilemaps, gridmaps, CSG, particles, audio, cameras, input, project settings, runtime game inspection, tests, and filesystem access. There are minor gaps such as resource deletion, animation trees/state machines, and some advanced resource workflows, but nothing that blocks typical editor automation.
Maintenance
Related MCP Connectors
Drive real devices from your AI Coding tool. Embed a client SDK (Unity, Godot, Flutter, iOS/macOS, Android, React Native, Web) in your app, then capture screenshots, traverse the UI tree, inject taps and key events, and run automated test tasks on the physical device over a secure relay.
Make games with AI: one MCP server that connects your agent to Unity, Unreal and Godot editors.
Let your coding agent read your GameSalad projects, and edit them live in Creator on Pro and Edu.
Connect AI assistants to your approved computer for files, commands, browser and desktop tasks.
Related MCP Servers
- AlicenseBqualityDmaintenanceEnables AI assistants to automate Godot 4 projects via headless tooling, live editor control, and runtime remote control, including scene building, testing, and observation.431MIT
- AlicenseCqualityDmaintenanceEnables AI assistants to interact with the Godot Engine editor and projects, including scene editing, script management, physics queries, and asset operations.1261MIT
- AlicenseNot gradedqualityBmaintenanceEnables AI assistants to build, run, and debug Godot projects by editing scenes and scripts, inspecting live game state, injecting input, capturing viewports, and examining native debugger state through 42 tools.European Union Public 1.2
- AlicenseBqualityBmaintenanceEnables AI assistants to automate the Godot Engine editor, including scene authoring, node transforms, tilemap editing, animation, shaders, and live GDScript execution via MCP.10030MIT