Skip to content
Back to search

godot-mcp

MCP server for interfacing with Godot game engine. Provides tools for launching the editor, running projects, and capturing debug output.

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today
Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/coding-solo--godot-mcp/badge.svg)](/listings/coding-solo--godot-mcp)

HTML

<a href="/listings/coding-solo--godot-mcp"><img src="/api/listings/coding-solo--godot-mcp/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

Claude Code

claude mcp add godot -- npx @coding-solo/godot-mcp

That's it. Restart Claude Code and your Godot MCP tools are available.

With environment variables:

claude mcp add godot -e GODOT_PATH=/path/to/godot -e DEBUG=true -- npx @coding-solo/godot-mcp

<details> <summary><strong>Cline</strong></summary>

Add to your Cline MCP settings file (`~/Library/Application Support/Code/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json`):

{
  "mcpServers": {
    "godot": {
      "command": "npx",
      "args": ["@coding-solo/godot-mcp"],
      "env": {
        "DEBUG": "true"
      },
      "disabled": false,
      "autoApprove": [
        "launch_editor",
        "run_project",
        "get_debug_output",
        "stop_project",
        "get_godot_version",
        "list_projects",
        "get_project_info",
        "create_scene",
        "add_node",
        "load_sprite",
        "export_mesh_library",
        "save_scene",
        "get_uid",
        "update_project_uids"
      ]
    }
  }
}

</details>

<details> <summary><strong>Cursor</strong></summary>

**Using the Cursor UI:**

1. Go to **Cursor Settings** > **Features** > **MCP** 2. Click on the **+ Add New MCP Server** button 3. Fill out the form: - Name: `godot` - Type: `command` - Command: `npx @coding-solo/godot-mcp` 4. Click "Add" 5. You may need to press the refresh button in the top right corner of the MCP server card to populate the tool list

**Using Project-Specific Configuration:**

Create a file at `.cursor/mcp.json` in your project directory:

{
  "mcpServers": {
    "godot": {
      "command": "npx",
      "args": ["@coding-solo/godot-mcp"],
      "env": {
        "DEBUG": "true"
      }
    }
  }
}

</details>

<details> <summary><strong>Other MCP Clients</strong></summary>

For any MCP-compatible client, use this configuration:

{
  "mcpServers": {
    "godot": {
      "command": "npx",
      "args": ["@coding-solo/godot-mcp"],
      "env": {
        "GODOT_PATH": "/path/to/godot",
        "DEBUG": "true"
      }
    }
  }
}

</details>

Environment Variables

| Variable | Description | |----------|-------------| | `GODOT_PATH` | Path to the Godot executable (overrides automatic detection) | | `DEBUG` | Set to `"true"` to enable detailed server-side debug logging |

<details> <summary><strong>Building from Source</strong></summary>

git clone https://github.com/Coding-Solo/godot-mcp.git
cd godot-mcp
npm install
npm run build

Then point your MCP client to `build/index.js` instead of using `npx`.

</details>

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md · README · 246 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

  1. # Godot MCP
  2. [![Github-sponsors](https://img.shields.io/badge/sponsor-30363D?style=for-the-badge&logo=GitHub-Sponsors&logoColor=#EA4AAA)](https://github.com/sponsors/Coding-Solo)
  3. [![](https://badge.mcpx.dev?type=server 'MCP Server')](https://modelcontextprotocol.io/introduction)
  4. [![Made with Godot](https://img.shields.io/badge/Made%20with-Godot-478CBF?style=flat&logo=godot%20engine&logoColor=white)](https://godotengine.org)
  5. [![](https://img.shields.io/badge/Node.js-339933?style=flat&logo=nodedotjs&logoColor=white 'Node.js')](https://nodejs.org/en/download/)
  6. [![](https://img.shields.io/badge/TypeScript-3178C6?style=flat&logo=typescript&logoColor=white 'TypeScript')](https://www.typescriptlang.org/)
  7. [![](https://img.shields.io/github/last-commit/Coding-Solo/godot-mcp 'Last Commit')](https://github.com/Coding-Solo/godot-mcp/commits/main)
  8. [![](https://img.shields.io/github/stars/Coding-Solo/godot-mcp 'Stars')](https://github.com/Coding-Solo/godot-mcp/stargazers)
  9. [![](https://img.shields.io/github/forks/Coding-Solo/godot-mcp 'Forks')](https://github.com/Coding-Solo/godot-mcp/network/members)
  10. [![](https://img.shields.io/badge/License-MIT-red.svg 'MIT License')](https://opensource.org/licenses/MIT)
  11. ```text
  12. ((((((( (((((((
  13. ((((((((((( (((((((((((
  14. ((((((((((((( (((((((((((((
  15. (((((((((((((((((((((((((((((((((
  16. (((((((((((((((((((((((((((((((((
  17. ((((( ((((((((((((((((((((((((((((((((((((((((( (((((
  18. (((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((
  19. ((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((
  20. ((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((
  21. (((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((
  22. (((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((
  23. (((((((((((@@@@@@@(((((((((((((((((((((((((((@@@@@@@(((((((((((
  24. (((((((((@@@@,,,,,@@@(((((((((((((((((((((@@@,,,,,@@@@(((((((((
  25. ((((((((@@@,,,,,,,,,@@(((((((@@@@@(((((((@@,,,,,,,,,@@@((((((((
  26. ((((((((@@@,,,,,,,,,@@(((((((@@@@@(((((((@@,,,,,,,,,@@@((((((((
  27. (((((((((@@@,,,,,,,@@((((((((@@@@@((((((((@@,,,,,,,@@@(((((((((
  28. ((((((((((((@@@@@@(((((((((((@@@@@(((((((((((@@@@@@((((((((((((
  29. (((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((
  30. (((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((
  31. @@@@@@@@@@@@@((((((((((((@@@@@@@@@@@@@((((((((((((@@@@@@@@@@@@@
  32. ((((((((( @@@(((((((((((@@(((((((((((@@(((((((((((@@@ (((((((((
  33. (((((((((( @@((((((((((@@@(((((((((((@@@((((((((((@@ ((((((((((
  34. (((((((((((@@@@@@@@@@@@@@(((((((((((@@@@@@@@@@@@@@(((((((((((
  35. (((((((((((((((((((((((((((((((((((((((((((((((((((((((((((
  36. (((((((((((((((((((((((((((((((((((((((((((((((((((((
  37. (((((((((((((((((((((((((((((((((((((((((((((((
  38. (((((((((((((((((((((((((((((((((
  39. /$$ /$$ /$$$$$$ /$$$$$$$
  40. | $$$ /$$$ /$$__ $$| $$__ $$
  41. | $$$$ /$$$$| $$ \__/| $$ \ $$
  42. | $$ $$/$$ $$| $$ | $$$$$$$/
  43. | $$ $$$| $$| $$ | $$____/
  44. | $$\ $ | $$| $$ $$| $$
  45. | $$ \/ | $$| $$$$$$/| $$
  46. |__/ |__/ \______/ |__/
  47. ```
  48. A Model Context Protocol (MCP) server for interacting with the Godot game engine.
  49. ## Introduction
  50. Godot MCP enables AI agents to launch the Godot editor, run projects, capture debug output, and control project execution. This direct feedback loop helps agents understand what works and what doesn't in real Godot projects, leading to better code generation and debugging assistance.
  51. ## Features
  52. - **Launch Godot Editor**: Open the Godot editor for a specific project
  53. - **Run Godot Projects**: Execute Godot projects in debug mode
  54. - **Capture Debug Output**: Retrieve console output and error messages
  55. - **Control Execution**: Start and stop Godot projects programmatically
  56. - **Get Godot Version**: Retrieve the installed Godot version
  57. - **List Godot Projects**: Find Godot projects in a specified directory
  58. - **Project Analysis**: Get detailed information about project structure
  59. - **Scene Management**:
  60. - Create new scenes with specified root node types
  61. - Add nodes to existing scenes with customizable properties
  62. - Load sprites and textures into Sprite2D nodes
  63. - Export 3D scenes as MeshLibrary resources for GridMap
  64. - Save scenes with options for creating variants
  65. - **UID Management** (for Godot 4.4+):
  66. - Get UID for specific files
  67. - Update UID references by resaving resources
  68. ## Requirements
  69. - [Godot Engine](https://godotengine.org/download) installed on your system
  70. - Node.js (>=18.0.0) and npm
  71. - An AI agent that supports MCP
  72. ## Quick Start
  73. ### Claude Code
  74. ```bash
  75. claude mcp add godot -- npx @coding-solo/godot-mcp
  76. ```
  77. That's it. Restart Claude Code and your Godot MCP tools are available.
  78. With environment variables:
  79. ```bash
  80. claude mcp add godot -e GODOT_PATH=/path/to/godot -e DEBUG=true -- npx @coding-solo/godot-mcp
  81. ```
  82. <details>
  83. <summary><strong>Cline</strong></summary>
  84. Add to your Cline MCP settings file (`~/Library/Application Support/Code/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json`):
  85. ```json
  86. {
  87. "mcpServers": {
  88. "godot": {
  89. "command": "npx",
  90. "args": ["@coding-solo/godot-mcp"],
  91. "env": {
  92. "DEBUG": "true"
  93. },
  94. "disabled": false,
  95. "autoApprove": [
  96. "launch_editor",
  97. "run_project",
  98. "get_debug_output",
  99. "stop_project",
  100. "get_godot_version",
  101. "list_projects",
  102. "get_project_info",
  103. "create_scene",
  104. "add_node",
  105. "load_sprite",
  106. "export_mesh_library",
  107. "save_scene",
  108. "get_uid",
  109. "update_project_uids"
  110. ]
  111. }
  112. }
  113. }
  114. ```
  115. </details>
  116. <details>
  117. <summary><strong>Cursor</strong></summary>
  118. **Using the Cursor UI:**
  119. 1. Go to **Cursor Settings** > **Features** > **MCP**
  120. 2. Click on the **+ Add New MCP Server** button
  121. 3. Fill out the form:
  122. - Name: `godot`
  123. - Type: `command`
  124. - Command: `npx @coding-solo/godot-mcp`
  125. 4. Click "Add"
  126. 5. You may need to press the refresh button in the top right corner of the MCP server card to populate the tool list
  127. **Using Project-Specific Configuration:**
  128. Create a file at `.cursor/mcp.json` in your project directory:
  129. ```json
  130. {
  131. "mcpServers": {
  132. "godot": {
  133. "command": "npx",
  134. "args": ["@coding-solo/godot-mcp"],
  135. "env": {
  136. "DEBUG": "true"
  137. }
  138. }
  139. }
  140. }
  141. ```
  142. </details>
  143. <details>
  144. <summary><strong>Other MCP Clients</strong></summary>
  145. For any MCP-compatible client, use this configuration:
  146. ```json
  147. {
  148. "mcpServers": {
  149. "godot": {
  150. "command": "npx",
  151. "args": ["@coding-solo/godot-mcp"],
  152. "env": {
  153. "GODOT_PATH": "/path/to/godot",
  154. "DEBUG": "true"
  155. }
  156. }
  157. }
  158. }
  159. ```
  160. </details>
  161. ### Environment Variables
  162. | Variable | Description |
  163. |----------|-------------|
  164. | `GODOT_PATH` | Path to the Godot executable (overrides automatic detection) |
  165. | `DEBUG` | Set to `"true"` to enable detailed server-side debug logging |
  166. <details>
  167. <summary><strong>Building from Source</strong></summary>
  168. ```bash
  169. git clone https://github.com/Coding-Solo/godot-mcp.git
  170. cd godot-mcp
  171. npm install
  172. npm run build
  173. ```
  174. Then point your MCP client to `build/index.js` instead of using `npx`.
  175. </details>
  176. ## Architecture
  177. The Godot MCP server uses a bundled GDScript approach for complex operations:
  178. 1. **Direct Commands**: Simple operations like launching the editor or getting project info use Godot's built-in CLI commands directly.
  179. 2. **Bundled Operations Script**: Complex operations like creating scenes or adding nodes use a single, comprehensive GDScript file (`godot_operations.gd`) that handles all operations.
  180. The bundled script accepts operation type and parameters as JSON, allowing for flexible and dynamic operation execution without generating temporary files for each operation.
  181. ## Troubleshooting
  182. - **Godot Not Found**: Set the `GODOT_PATH` environment variable to your Godot executable path
  183. - **Connection Issues**: Ensure the server is running and restart your AI assistant
  184. - **Invalid Project Path**: Ensure the path points to a directory containing a `project.godot` file
  185. - **Build Issues**: Make sure all dependencies are installed by running `npm install`
  186. <details>
  187. <summary><strong>Cursor-Specific Issues</strong></summary>
  188. - Ensure the MCP server shows up and is enabled in Cursor settings (Settings > MCP)
  189. - MCP tools can only be run using the Agent chat profile (Cursor Pro or Business subscription)
  190. - Use "Yolo Mode" to automatically run MCP tool requests
  191. </details>
  192. ## License
  193. This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.