Command Palette

Search for a command to run...

UnylyUnyly
Browse all

Niua Godot

FreeNot checked

A local MCP server plus a bundled Godot editor addon that lets an AI agent create, inspect, run, debug, and export real Godot 4.6 games through tools.

GitHubEmbed

About

A local MCP server plus a bundled Godot editor addon that lets an AI agent create, inspect, run, debug, and export real Godot 4.6 games through tools.

README

v0.1.12

Your AI builds real Godot games on your machine.

Install once. Chat. Godot opens, scenes appear, the game runs. All local.


60-second install

Option A — paste this to your AI (easiest)

Copy into Claude Code, Cursor, Codex, or any agent with shell access:

Install NIUA Godot MCP for me.
Follow: https://raw.githubusercontent.com/OhaoTech/niua-godot-mcp/main/docs/godot-mcp/INSTALL-BY-AGENT.md
Ask before writing any config. Then call get_godot_version.

Restart the AI client when it says so. Done.

Option B — do it yourself

Need: Node 20+ · Godot 4.7 · Claude / Cursor / Codex / etc.

git clone https://github.com/OhaoTech/niua-godot-mcp.git
cd niua-godot-mcp
mkdir -p ~/Godot/NIUAProjects

Claude Code:

claude mcp add niua-godot -s user \
  --env GODOT_MCP_ALLOWED_PROJECT_ROOTS="$HOME/Godot/NIUAProjects" \
  -- node "$(pwd)/src/godot-mcp/cli.js"

Codex / Claude Desktop / Cursor:

# preview
node src/godot-mcp/cli.js setup --client codex --project-root "$HOME/Godot/NIUAProjects"
# write (use --client claude or --client generic for others)
node src/godot-mcp/cli.js setup --client codex --project-root "$HOME/Godot/NIUAProjects" --write

Restart your AI tool.


First game

Ask your AI:

Create a Godot project at ~/Godot/NIUAProjects/first-game.
Build a 3D scene with a ground, a cube, a camera, and a light.
Save it, set it as main, then call run_playtest_evidence and tell me the evidence claims.

You should see Godot open and a real game window. The agent gets one compact evidence pack (run + observe + screenshot contract) instead of a hand-rolled tool loop.


If something breaks

Problem Fix
Unable to run Godot Install Godot 4.7, or set GODOT_BIN=/path/to/godot in the MCP config
outside allowed project roots Put projects under ~/Godot/NIUAProjects (or the folder you chose)
bridge is not reachable Ask the AI: “open the project with open_project”
Tools missing Restart the AI client after install
Godot stuck on a dialog Press Esc in Godot; ask the AI to save the scene before run

Health check:

cd niua-godot-mcp && node src/godot-mcp/doctor.js

More help: troubleshooting


Optional

Teach the AI the safe build loop (recommended)
# Claude Code
mkdir -p ~/.claude/skills && cp -r skills/niua-godot ~/.claude/skills/

# Codex / agents
mkdir -p ~/.agents/skills && cp -r skills/niua-godot ~/.agents/skills/
JS SDK (scripts, no chat spam)

After the AI has opened a project once:

node examples/sdk-quickstart.mjs ~/Godot/NIUAProjects/first-game
import { connect } from "niua-godot-mcp/sdk";
const godot = connect({ expectedProjectRoot: "/path/to/project" });
// no tokens to configure
Tool profiles & experimental tools

Default is core (~52 tools) — enough for real games.

  • full — every stable tool
  • compact — full surface behind 13 routers
node src/godot-mcp/cli.js setup --client codex --project-root "$HOME/Godot/NIUAProjects" --profile full --write

Experimental tools (multiplayer, nav, export, …) stay hidden unless you set NIUA_MCP_EXPERIMENTAL=on. Catalog: tools.md

Developers
npm test
npm run godot:mcp:docs

License

PolyForm Small Business 1.0.0 — free for individuals and orgs under ~100 people / ~$1M revenue. Larger orgs: [email protected]

from github.com/OhaoTech/niua-godot-mcp

Installing Niua Godot

This server has no published package — it is built from source. Open the repository and follow its README.

▸ github.com/OhaoTech/niua-godot-mcp

FAQ

Is Niua Godot MCP free?

Yes, Niua Godot MCP is free — one-click install via Unyly at no cost.

Does Niua Godot need an API key?

No, Niua Godot runs without API keys or environment variables.

Is Niua Godot hosted or self-hosted?

Self-hosted: the server runs locally on your machine via the install command above.

How do I install Niua Godot in Claude Desktop, Claude Code or Cursor?

Open Niua Godot on unyly.org, pick your client tab (Claude Desktop, Claude Code, Cursor) and press Install — the config is generated automatically, no JSON editing.

Related MCPs

Compare Niua Godot with

Not sure what to pick?

Find your stack in 60 seconds

Author?

Embed badge for your README

Browse similar

All ai MCPs