Skip to content

Install the MCP server ​

For readers who know MCP

This is the manual / technical path. Rather not touch a terminal? → Set up with your AI agent has your assistant do it.

bash
uv tool install godot-editor-mcp    # or: pip install godot-editor-mcp
godot-editor-mcp                    # starts the MCP server over stdio

Option B: Docker ​

bash
docker run -d -p 9090:9090 -p 9080:9080 \
  -e GODOT_MCP_AUTH_TOKEN=$(openssl rand -hex 32) \
  ghcr.io/hybridindie/godot-mcp:latest

Docker binds 0.0.0.0 inside the container, so a bearer token is required (#226). The server refuses to start on a non-loopback bind without one.

Option C: From source (development) ​

bash
git clone https://github.com/hybridindie/godot-mcp
cd godot-mcp
uv sync
uv run godot-editor-mcp   # stdio mode (default)

Choose a transport ​

TransportUse caseHow
stdio (default)A single local agentthe client spawns godot-editor-mcp itself
httpShared service; several clients on one editor; remote/web UIsGODOT_MCP_TRANSPORT=http or scripts/serve-http.sh

Service mode for multiple clients

The bridge to the editor is a single connection — one server process owns it at a time. To give several clients (OpenCode, Claude, OpenWebUI, an eval harness) the same live editor, run one HTTP service and point every client at http://<host>:9090/mcp:

bash
GODOT_MCP_TRANSPORT=http GODOT_MCP_AUTH_TOKEN=<token> \
  uv run godot-editor-mcp

Non-loopback HTTP binds require a GODOT_MCP_AUTH_TOKEN — the server refuses to start without one (fail-fast, #226).

Verify ​

bash
GODOT_MCP_BRIDGE_URL=ws://127.0.0.1:9080 uv run godot-editor-mcp
# logs are JSON on stderr; the MCP protocol is on stdout

The server binds the bridge listener immediately — before Godot exists. Next: install the addon.

194 tools · 29 toolsets · contract version 1