# godot-mcp

MCP server for Godot editor automation.

## Use

Install the editor bridge into a Godot project:

```sh
uv run godot-mcp --project /path/to/project install-plugin
```

Enable **Godot MCP Bridge** in Godot's Project Settings > Plugins, then run the
MCP server:

```sh
uv run godot-mcp --project /path/to/project --godot godot serve
```

The Python MCP server exposes script read/write/check tools, scene tree and
scene edit tools, generic guarded editor calls, and runtime log diagnostics.

Scene and editor operations require the Godot editor plugin to be enabled. File
operations and `run_project` work from Python directly.

## Codex setup

Install the plugin, create a Codex skill, and register the MCP server:

```sh
uv run godot-mcp \
  --project /path/to/godot-project \
  --godot /opt/homebrew/bin/godot \
  setup-codex
```

The command writes a `godot-mcp` skill to `~/.codex/skills/godot-mcp` and adds a
Codex MCP server named `godot`. Restart Codex, open the Godot editor, and enable
**Godot MCP Bridge** in Project Settings > Plugins.

Use `--replace` to refresh an existing `godot` MCP config, `--mcp-name` to use a
different server name, or `--dry-run` to print the changes without writing them.