For developers
You know MCP and want the internals, a stable integration surface, or to contribute. This track is the technical map.
Godot Editor MCP is a generic, game-agnostic MCP server. It drives a live Godot editor — the editor is the surface, reached through the addon — rather than editing files blindly on disk.
The shape in one picture
text
AI client ──stdio / HTTP──▶ FastMCP server ──WebSocket──▶ Godot addon ──▶ live editor- The server (
mcp_server/) owns safety, preconditions, typed models, the tool surface, and the WebSocket listener. - The addon (
godot/addons/godot_mcp/) is the only code that touches the Godot Editor API. It dials out to the server and reconnects. - The JSON envelope (
{id, command, params}→{id, ok, result, error}) joins them.
Set up
- Install the MCP server — PyPI, Docker, or source.
- Install the Godot addon — Asset Store, copy, or the bundled project.
- Configure your MCP client — stdio or Streamable HTTP.
- Remote & multi-client — one HTTP service, several clients, one editor.
Understand the contract
- Concepts — the mental model: editor-first, toolsets, safety classes, the envelope, honesty fields.
- The compatibility contract — what the contract is, why it has its own version, and how to negotiate it at startup.
- Reference — the readable map of the surface.
- Toolsets & tools — every tool and its safety class.
- Safety classes —
dry_run/confirmsemantics. - Value shapes — how Godot types arrive as JSON.
- Errors & recovery — the stable error enum and recovery hints.
- Prompts & resources — workflow templates and
godot://snapshots. - Environment variables — every server and addon knob.
- Tool contracts — the authoritative per-tool schema (source of truth).
Go under the hood
- The four-layer chain — where every responsibility lives.
- The Godot addon — dial-out client, router, dock, undo.
- Bridge & transport — lifecycle, backoff, timeouts.
- The JSON envelope — correlation and error codes.
- Toolset gating — the enabled set and
list_changed. - The safety model — classes, preconditions, gates.
- Persistence truth — the owner chain and save verdicts.
- The readiness envelope — why nothing stalls silently.
Integrate or extend
- Consumer integration — layering game-specific agents on top, pinning the tool names, params, envelope, and contract version.
- Skills — the three installable AI skills.
- Contributing — setup, workflow, conventions, and the grounding rules.
Stable identifiers
| Thing | Value | Change policy |
|---|---|---|
| Product name | Godot Editor MCP | human-facing |
| Repository | hybridindie/godot-mcp | stable |
| MCP server ID | godot-mcp | wire compatibility |
| Package / CLI | godot-editor-mcp | published name |
| Addon | Godot Editor MCP - Addon | Asset Store name |
| Tools | godot_<toolset>_<action> | gated by the prefix |
| Contract version | contract_version in godot_get_server_info | additive changes do not bump it |
Read the naming note for why the product name and the identifiers differ.
Just want to make a game? The creator track skips all of this.