godot-mcp-pro
starsforks
How to install godot-mcp-pro?
youichi-uda/godot-mcp-pro
$git clone https://github.com/youichi-uda/godot-mcp-proPremium MCP (Model Context Protocol) server for AI-powered Godot game development. Connects AI assistants like Claude directly to your Godot editor with 175 powerful tools.
README.md
| 1 | # Godot MCP Pro |
| 2 | |
| 3 | Premium MCP (Model Context Protocol) server for AI-powered Godot game development. Connects AI assistants like Claude directly to your Godot editor with **175 powerful tools**. |
| 4 | |
| 5 | ## Architecture |
| 6 | |
| 7 | ``` |
| 8 | AI Assistant ←—stdio/MCP—→ Node.js Server ←—WebSocket:6505—→ Godot Editor Plugin |
| 9 | ``` |
| 10 | |
| 11 | - **Real-time**: WebSocket connection means instant feedback, no file polling |
| 12 | - **Editor Integration**: Full access to Godot's editor API, UndoRedo system, and scene tree |
| 13 | - **JSON-RPC 2.0**: Standard protocol with proper error codes and suggestions |
| 14 | |
| 15 | ## What's in this repo |
| 16 | |
| 17 | > ⚠️ **This public repo only contains the free Godot addon/plugin.** The MCP server (Node.js, required to connect AI assistants) is distributed as part of the paid package — **one-time purchase**, lifetime updates: |
| 18 | > |
| 19 | > - **Buy Me a Coffee**: <https://buymeacoffee.com/y1uda/extras> |
| 20 | > - **itch.io**: <https://y1uda.itch.io/godot-mcp-pro> |
| 21 | > |
| 22 | > The paid zip includes the addon, the `server/` directory with pre-built JavaScript, `INSTALL.md`, and AI-client instructions. If you cloned this repo and don't see a `server/` folder, **that's expected** — grab the full package from one of the links above. |
| 23 | |
| 24 | ## Quick Start |
| 25 | |
| 26 | ### 1. Install the Godot Plugin |
| 27 | |
| 28 | Copy the `addons/godot_mcp/` folder into your Godot project's `addons/` directory. |
| 29 | |
| 30 | Enable the plugin: **Project → Project Settings → Plugins → Godot MCP Pro → Enable** |
| 31 | |
| 32 | ### 2. Install the MCP Server |
| 33 | |
| 34 | > The `server/` directory is only included in the **full paid package** (see above). After downloading and extracting the zip, run: |
| 35 | |
| 36 | ```bash |
| 37 | cd server |
| 38 | npm install |
| 39 | npm run build |
| 40 | ``` |
| 41 | |
| 42 | ### 3. Configure Claude Code |
| 43 | |
| 44 | Add to your `.mcp.json`: |
| 45 | |
| 46 | ```json |
| 47 | { |
| 48 | "mcpServers": { |
| 49 | "godot-mcp-pro": { |
| 50 | "command": "node", |
| 51 | "args": ["/path/to/server/build/index.js"], |
| 52 | "env": { |
| 53 | "GODOT_MCP_PORT": "6505" |
| 54 | } |
| 55 | } |
| 56 | } |
| 57 | } |
| 58 | ``` |
| 59 | |
| 60 | ### 4. Choose Your Mode |
| 61 | |
| 62 | Godot MCP Pro offers four modes to fit any client's tool limit: |
| 63 | |
| 64 | | Mode | Tools | Best For | |
| 65 | |------|-------|----------| |
| 66 | | **Full** (default) | 175 | Claude Code, Cline, VS Code Copilot, Cursor | |
| 67 | | **3D** (`--3d`) | 103 | Antigravity and other 100-tool-limit clients needing 3D | |
| 68 | | **Lite** (`--lite`) | 84 | Windsurf, JetBrains Junie, Gemini CLI | |
| 69 | | **Minimal** (`--minimal`) | 35 | OpenCode, local LLMs with small context | |
| 70 | |
| 71 | ```json |
| 72 | { |
| 73 | "mcpServers": { |
| 74 | "godot-mcp-pro": { |
| 75 | "command": "node", |
| 76 | "args": ["/path/to/server/build/index.js", "--lite"] |
| 77 | } |
| 78 | } |
| 79 | } |
| 80 | ``` |
| 81 | |
| 82 | Replace `--lite` with `--minimal` for the smallest footprint. |
| 83 | |
| 84 | - **Lite** includes: project, scene, node, script, editor, input, runtime, and input_map tools. |
| 85 | - **Minimal** includes: 35 essential tools — project info, scene management, node CRUD, script editing, editor errors, input simulation, and runtime inspection. |
| 86 | |
| 87 | ### 5. CLI Mode (Alternative to MCP) |
| 88 | |
| 89 | For clients without MCP support, or when you want zero context overhead, use the CLI directly from a terminal/bash tool. The CLI requires the server to be built first (Step 2). |
| 90 | |
| 91 | ```bash |
| 92 | # Top-level help — shows all command groups |
| 93 | node /path/to/server/build/cli.js --help |
| 94 | |
| 95 | # Group help — shows commands in a group |
| 96 | node /path/to/server/build/cli.js node --help |
| 97 | |
| 98 | # Command help — shows options for a command |
| 99 | node /path/to/server/build/cli.js node add --help |
| 100 | |
| 101 | # Execute |
| 102 | node /path/to/server/build/cli.js project info |
| 103 | node /path/to/server/build/cli.js scene play |
| 104 | node /path/to/server/build/cli.js node add --type CharacterBody3D --name Player |
| 105 | ``` |
| 106 | |
| 107 | Replace `/path/to/` with the actual path where you extracted the files. |
| 108 | |
| 109 | The CLI connects directly to the Godot editor plugin via WebSocket. It requires: |
| 110 | - Godot editor running with the MCP plugin enabled |
| 111 | - Server built (`node build/setup.js install`) |
| 112 | - An available port in the 6510-6514 range |
| 113 | |
| 114 | **Advantage**: LLMs discover capabilities progressively via `--help` instead of loading all tool definitions upfront. This works with any LLM client that has terminal access, regardless of tool count limits. |
| 115 | |
| 116 | ### 6. Client Compatibility |
People who liked this also viewed
6 picksType
- fastapi_mcpExpose your FastAPI endpoints as Model Context Protocol (MCP) tools, with Auth!MCP ServersNov 2025
- lean-lsp-mcpLean Theorem Prover MCPMCP ServersJul 2026
- rulesyncA Utility CLI for AI Coding AgentsMCP ServersJul 2026
- FunASROpen-source speech recognition toolkit for training, inference, streaming ASR, VAD, punctuation, speaker diarization pipelines, and OpenAI-compatible/MCP serving.MCP ServersJul 2026
- repomix📦 Repomix is a powerful tool that packs your entire repository into a single, AI-friendly file. Perfect for when you need to feed your codebase to Large Language Models (LLMs) or other AI tools like Claude, ChatGPT, DeepSeek, Perplexity, Gemini, Gemma, Llama, Grok, and more.MCP ServersJul 2026
- mcp-serverMCP server for AI-assisted development of CAP applicationsMCP ServersJul 2026
