Skip to content
Back to search

Doyunha-Gopeak

GoPeak — The most comprehensive MCP server for Godot Engine. 95+ tools: scene management, GDScript LSP, DAP debugger, screenshot capture, input injection, ClassDB introspection, CC0 asset library. npx gopeak

Safety scan

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

Checked today

Check it deeper on your machine

It has changed since its scan on 11 Nov 2026.

As a Claude Code plugin, install it and then ask Claude Code:

/plugin marketplace add keithmackay/mackayi/plugin install scanskillsafety@mackayiDo a deep scan of https://github.com/HaD0Yun/Doyunha-Gopeak with scanskillsafety

Or from a terminal, clone it and run it:

git clone https://github.com/keithmackay/scanskillsafety-skill ~/.claude/skills/scanskillsafetynode ~/.claude/skills/scanskillsafety/cli.cjs --deep 'https://github.com/HaD0Yun/Doyunha-Gopeak'

It checks the exact commit: every file, its packages against OSV (api.osv.dev), how it compares with this page's scan (findsafeskills.com receives the repository's address), and, if you agree, Claude reading every file with your own Claude subscription. It never runs the code.

Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/had0yun--doyunha-gopeak/badge.svg)](/listings/had0yun--doyunha-gopeak)

HTML

<a href="/listings/had0yun--doyunha-gopeak"><img src="/api/listings/had0yun--doyunha-gopeak/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.

Requirements

- Godot 4.x - Bun 1.3.3+ - MCP-compatible client such as Claude Desktop, Cursor, Cline, or OpenCode

1) Install GoPeak

bun add -g https://github.com/HaD0Yun/Doyunha-Gopeak/releases/download/v2.4.0/gopeak-2.4.0.tgz

That is the quickest installation path. It installs the bundled runtime directly from GitHub Releases without npm. For a checksum-verified installation, use:

curl -fLO https://github.com/HaD0Yun/Doyunha-Gopeak/releases/download/v2.4.0/gopeak-2.4.0.tgz
curl -fLO https://github.com/HaD0Yun/Doyunha-Gopeak/releases/download/v2.4.0/gopeak-2.4.0.tgz.sha256
if command -v sha256sum >/dev/null 2>&1; then
  sha256sum -c gopeak-2.4.0.tgz.sha256
else
  shasum -a 256 -c gopeak-2.4.0.tgz.sha256
fi
bun add -g "$PWD/gopeak-2.4.0.tgz"

The verified path checks the downloaded release before Bun installs it globally. The absolute tarball path avoids a relative-path bug in Bun 1.3.3. The checksum command works on Linux (`sha256sum`) and macOS (`shasum`). To use the supported installer instead, download or clone the repository and run it locally—do not pipe a remote script into a shell:

git clone https://github.com/HaD0Yun/Doyunha-Gopeak.git
cd Doyunha-Gopeak
./install.sh

The release archive contains the bundled runtime. Installation and execution do not contact the npm registry or require npm credentials. For stronger provenance checking, release reviewers can also verify the GitHub artifact attestation as described in the [release process](docs/release-process.md).

If you used the old installer, `--dir`, `--godot`, and `--configure` remain accepted with warnings through the `2.3.x` line and are planned for removal in `3.0.0`. The new mappings are: use Bun's global home (`BUN_INSTALL`) instead of a source checkout directory, put `GODOT_PATH` in the MCP client `env`, and use the configuration below instead of relying on installer output. During the compatibility window, `--godot` and `--configure` still print a client snippet but never write client files. See the [migration policy](docs/migration-policy.md#bun-distribution-migration) for the exact contract.

2) Add MCP client config

{
  "mcpServers": {
    "godot": {
      "command": "gopeak",
      "args": [],
      "env": {
        "GODOT_PATH": "/path/to/godot",
        "GOPEAK_TOOL_PROFILE": "compact"
      }
    }
  }
}

`compact` is the default profile. It keeps the initial MCP context small and exposes additional setup-gated groups only when requested.

3) Try these prompts

- "List Godot projects in `/your/projects` and show project info." - "Create `scenes/Player.tscn` with a `CharacterBody2D` root and a movement script." - "Run the project, read the debug output, and fix the top error." - "Use `tool.catalog` to find animation tools, then activate the right group."

---

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 · 294 lines

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

This file has changed since it was scanned, so this is not exactly the text that was scanned, and no line is marked. The findings are listed with the safety scan above.

  1. # GoPeak
  2. [![](https://badge.mcpx.dev?type=server 'MCP Server')](https://modelcontextprotocol.io/introduction)
  3. [![Made with Godot](https://img.shields.io/badge/Made%20with-Godot-478CBF?style=flat&logo=godot%20engine&logoColor=white)](https://godotengine.org)
  4. [![Bun](https://img.shields.io/badge/Bun-1.3.3%2B-f9f1e1?style=flat&logo=bun&logoColor=black 'Bun')](https://bun.sh/)
  5. [![GitHub Release](https://img.shields.io/github/v/release/HaD0Yun/Doyunha-Gopeak?style=flat&logo=github 'GitHub Release')](https://github.com/HaD0Yun/Doyunha-Gopeak/releases)
  6. [![](https://img.shields.io/badge/License-MIT-red.svg 'MIT License')](https://opensource.org/licenses/MIT)
  7. 🌐 **Languages**: **English** | [한국어](README-ko.md) | [日本語](README-ja.md) | [Deutsch](README-de.md) | [Português](README-pt_BR.md) | [简体中文](README-zh.md)
  8. ![GoPeak Hero](assets/gopeak-hero-v2.png)
  9. **GoPeak is an MCP server for Godot 4 that gives AI assistants a real edit → run → inspect → fix loop.**
  10. It is designed for trusted Godot 4 workflows: small default tool surface, setup-gated advanced capabilities, and explicit compatibility rules for older/legacy tool names.
  11. > English is the canonical source of truth. Localized READMEs are concise overviews and may lag behind `README.md`.
  12. >
  13. > Discord is temporarily unavailable while the invite link is refreshed. Use [GitHub Discussions](https://github.com/HaD0Yun/Doyunha-Gopeak/discussions) for now.
  14. ---
  15. ## Quick Start
  16. ### Requirements
  17. - Godot 4.x
  18. - Bun 1.3.3+
  19. - MCP-compatible client such as Claude Desktop, Cursor, Cline, or OpenCode
  20. ### 1) Install GoPeak
  21. ```bash
  22. bun add -g https://github.com/HaD0Yun/Doyunha-Gopeak/releases/download/v2.4.1/gopeak-2.4.1.tgz
  23. ```
  24. That is the quickest installation path. It installs the bundled runtime directly from GitHub Releases without npm. For a checksum-verified installation, use:
  25. ```bash
  26. curl -fLO https://github.com/HaD0Yun/Doyunha-Gopeak/releases/download/v2.4.1/gopeak-2.4.1.tgz
  27. curl -fLO https://github.com/HaD0Yun/Doyunha-Gopeak/releases/download/v2.4.1/gopeak-2.4.1.tgz.sha256
  28. if command -v sha256sum >/dev/null 2>&1; then
  29. sha256sum -c gopeak-2.4.1.tgz.sha256
  30. else
  31. shasum -a 256 -c gopeak-2.4.1.tgz.sha256
  32. fi
  33. bun add -g "$PWD/gopeak-2.4.1.tgz"
  34. ```
  35. The verified path checks the downloaded release before Bun installs it globally. The absolute tarball path avoids a relative-path bug in Bun 1.3.3. The checksum command works on Linux (`sha256sum`) and macOS (`shasum`). To use the supported installer instead, download or clone the repository and run it locally—do not pipe a remote script into a shell:
  36. ```bash
  37. git clone https://github.com/HaD0Yun/Doyunha-Gopeak.git
  38. cd Doyunha-Gopeak
  39. ./install.sh
  40. ```
  41. The release archive contains the bundled runtime. Installation and execution do not contact the npm registry or require npm credentials. For stronger provenance checking, release reviewers can also verify the GitHub artifact attestation as described in the [release process](docs/release-process.md).
  42. If you used the old installer, `--dir`, `--godot`, and `--configure` remain accepted with warnings through the `2.3.x` line and are planned for removal in `3.0.0`. The new mappings are: use Bun's global home (`BUN_INSTALL`) instead of a source checkout directory, put `GODOT_PATH` in the MCP client `env`, and use the configuration below instead of relying on installer output. During the compatibility window, `--godot` and `--configure` still print a client snippet but never write client files. See the [migration policy](docs/migration-policy.md#bun-distribution-migration) for the exact contract.
  43. ### 2) Add MCP client config
  44. ```json
  45. {
  46. "mcpServers": {
  47. "godot": {
  48. "command": "gopeak",
  49. "args": [],
  50. "env": {
  51. "GODOT_PATH": "/path/to/godot",
  52. "GOPEAK_TOOL_PROFILE": "compact"
  53. }
  54. }
  55. }
  56. }
  57. ```
  58. `compact` is the default profile. It keeps the initial MCP context small and exposes additional setup-gated groups only when requested.
  59. ### 3) Try these prompts
  60. - "List Godot projects in `/your/projects` and show project info."
  61. - "Create `scenes/Player.tscn` with a `CharacterBody2D` root and a movement script."
  62. - "Run the project, read the debug output, and fix the top error."
  63. - "Use `tool.catalog` to find animation tools, then activate the right group."
  64. ---
  65. ## What You Get
  66. | Workflow | What GoPeak can do |
  67. |---|---|
  68. | Project control | Find projects, launch the editor, run/stop the game, collect debug output. |
  69. | Scene + script editing | Create scenes, add nodes, edit typed properties, create/modify GDScript. |
  70. | Resource workflows | Work with resources, materials, shaders, imports, and export-related checks. |
  71. | Debugging | Use logs, Godot LSP diagnostics, DAP breakpoints/stack traces, and runtime inspection when configured. |
  72. | Runtime testing | Capture screenshots, inspect live trees, inject input, and call runtime methods through the addon. |
  73. | Tool discovery | Keep the default surface compact, then activate capability groups with `tool.catalog` or `tool.groups`. |
  74. ### Setup gates
  75. Some capabilities require extra Godot-side services. GoPeak labels these instead of pretending everything is always available:
  76. | Capability | Requires |
  77. |---|---|
  78. | Editor bridge scene/resource edits | `godot_mcp_editor` plugin enabled in the Godot project. |
  79. | Runtime inspection, screenshots, input injection | Runtime addon/socket, default port `7777`. |
  80. | GDScript LSP tools | Godot LSP enabled on port `6005`. |
  81. | DAP debugging tools | Godot DAP enabled on port `6006`. |
  82. | Asset store/provider tools | Network access and provider availability. |
  83. ---
  84. ## Add the Godot Plugins
  85. Install from your Godot project folder:
  86. ```bash
  87. curl -sL https://raw.githubusercontent.com/HaD0Yun/Doyunha-Gopeak/main/install-addon.sh | bash
  88. ```
  89. PowerShell:
  90. ```powershell
  91. iwr https://raw.githubusercontent.com/HaD0Yun/Doyunha-Gopeak/main/install-addon.ps1 -UseBasicParsing | iex
  92. ```
  93. Then enable plugins in **Project Settings → Plugins**:
  94. - `godot_mcp_editor` for bridge-backed scene/resource tools
  95. - `godot_mcp_runtime` for runtime inspection, screenshots, and input workflows
  96. Optional shell hooks for update notifications are opt-in:
  97. ```bash
  98. gopeak setup
  99. ```
  100. `gopeak setup` only modifies supported bash/zsh rc files when you run it explicitly. Installing the release asset does not add shell hooks automatically.
  101. ---
  102. ## Tool Profiles
  103. GoPeak supports three exposure profiles:
  104. | Profile | Use when |
  105. |---|---|
  106. | `compact` | Default. Trusted core tools plus dynamic groups activated on demand. |
  107. | `full` | Compatibility/audit mode for the full legacy surface. |
  108. | `legacy` | Older config alias with the same exposed behavior as `full`. |
  109. Set either `GOPEAK_TOOL_PROFILE` or the fallback alias `MCP_TOOL_PROFILE`.
  110. ### Dynamic groups
  111. In compact mode, search with `tool.catalog`; matching groups auto-activate. You can also manage groups directly with `tool.groups`.
  112. Common groups:
  113. | Group | Status | Notes |
  114. |---|---|---|
  115. | `runtime` | optional-runtime | Live scene tree, properties, method calls, metrics. Requires runtime addon/socket. |
  116. | `testing` | optional-runtime | Screenshots, viewport capture, input injection. Requires runtime/editor setup. |
  117. | `lsp` | optional-lsp | Diagnostics, completion, hover, symbols. Requires Godot LSP on port `6005`. |
  118. | `dap` | optional-dap | Breakpoints, stepping, stack traces. Requires Godot DAP on port `6006`. |
  119. | `asset_store` | optional-network | External CC0 asset search/download. Network/provider dependent. |
  120. | `class_advanced` | trusted-static | ClassDB/inheritance discovery backed by static engine metadata. |
  121. | `tilemap` | audit-required | Must account for Godot 4.3+ `TileMapLayer` behavior before promotion. |
  122. | mutation groups | audit-required | Scene/resource/script/settings/signal/autoload/import/audio/navigation/theme/animation groups need fixture evidence before being marketed as fully trusted. |
  123. | `intent_tracking` | workflow-layer | Workflow memory/handoff helpers, not a Godot engine primitive. Keep opt-in. |
  124. If your MCP client does not refresh after activation, reconnect the client or call the newly activated tool once to force a fresh `tools/list` round-trip.
  125. GoPeak also uses cursor-based pagination for `tools/list` so large profiles are not dumped into context at once. Tune it with `GOPEAK_TOOLS_PAGE_SIZE` when needed.
  126. ---
  127. ## Typed Godot Values
  128. Bridge-backed scene tools such as `add_node` and `set_node_properties` accept common vector payloads for typed properties:
  129. ```json
  130. {
  131. "position": { "type": "Vector2", "x": 100, "y": 200 },
  132. "scale": { "type": "Vector2", "x": 2, "y": 2 }
  133. }
  134. ```
  135. Plain `{ "x": 100, "y": 200 }` and `[100, 200]` are also coerced for common `Vector2` fields, but tagged values are safest across tools.
  136. ---
  137. ## Useful Commands
  138. ```bash
  139. # run the globally installed CLI
  140. gopeak
  141. # run from source
  142. git clone https://github.com/HaD0Yun/Doyunha-Gopeak.git
  143. cd Doyunha-Gopeak
  144. bun ci
  145. bun run build
  146. bun run ./build/index.js
  147. # local verification
  148. bun run ci
  149. bun run test:dynamic-groups
  150. bun run test:metadata
  151. bun run test:packaging
  152. ```
  153. CLI bin names:
  154. - `gopeak`
  155. - `godot-mcp`
  156. ---
  157. ## Environment & Ports
  158. | Name | Purpose | Default |
  159. |---|---|---|
  160. | `GOPEAK_TOOL_PROFILE` | Tool exposure profile: `compact`, `full`, `legacy` | `compact` |
  161. | `MCP_TOOL_PROFILE` | Fallback profile env alias | `compact` |
  162. | `GODOT_PATH` | Explicit Godot executable path | auto-detect |
  163. | `GODOT_BRIDGE_PORT` | Bridge/Visualizer HTTP+WS port override | `6505` |
  164. | `GOPEAK_BRIDGE_HOST` | Bridge/Visualizer bind host | `127.0.0.1` |
  165. | `GOPEAK_TOOLS_PAGE_SIZE` | Number of tools per `tools/list` page | `34` |
  166. | `GOPEAK_RUNTIME_TIMEOUT_MS` | Runtime addon command timeout in milliseconds | `10000` |
  167. | `DEBUG` | Enable server debug logs | `false` |
  168. | `LOG_MODE` | Recording mode: `lite` or `full` | `lite` |
  169. | Port | Service |
  170. |---|---|
  171. | `6505` | Unified Godot Bridge + Visualizer server on loopback by default. |
  172. | `6005` | Godot LSP. |
  173. | `6006` | Godot DAP. |
  174. | `7777` | Runtime addon command socket. |
  175. Runtime screenshot tools (`capture_screenshot`, `capture_viewport`) use a GoPeak-managed temporary PNG file when the runtime addon supports `output_path`, then return normal MCP image content. Older runtime addons that do not receive an `output_path` continue to return inline base64 screenshots.
  176. ---
  177. ## Troubleshooting
  178. - **Godot not found** → set `GODOT_PATH`.
  179. - **No MCP tools visible** → restart your MCP client.
  180. - **Need a hidden tool** → search with `tool.catalog` or activate a group with `tool.groups`.
  181. - **Project path invalid** → confirm `project.godot` exists.
  182. - **Runtime tools not working** → install/enable the runtime addon and check port `7777`.
  183. - **Runtime screenshots time out** → update the runtime addon so screenshot commands support the managed `output_path` flow. For slow runtime responses, raise `GOPEAK_RUNTIME_TIMEOUT_MS`; older addons may still time out on large inline base64 screenshots.
  184. - **Editor bridge disconnected** → stop duplicate `gopeak`/MCP servers that may already own bridge port `6505`; `get_editor_status` reports bridge startup errors such as `EADDRINUSE`.
  185. ---
  186. ## Migration & Deprecation Policy
  187. GoPeak treats `compact` as the safe default and `full`/`legacy` as compatibility profiles. Future hide, remove, rename, or API-contract changes must include:
  188. 1. old → new mapping or an explicit no-replacement note;
  189. 2. profile impact (`compact`, `full`, `legacy`, or opt-in group);
  190. 3. alias window and planned removal timing;
  191. 4. README/docs and release-note updates;
  192. 5. verification proving `tools/list` exposure and alias behavior;
  193. 6. migration prompt examples for common Godot workflows.
  194. Current stance: legacy tool names and compact aliases remain supported. Optional external groups (`runtime`, `testing`, `lsp`, `dap`, `asset_store`) are setup-gated, not always-available core behavior.
  195. Full policy: [docs/migration-policy.md](docs/migration-policy.md).
  196. ---
  197. ## More Docs
  198. - [Documentation Map](docs/README.md)
  199. - [Architecture](docs/architecture.md)
  200. - [Migration Policy](docs/migration-policy.md)
  201. - [Release Process](docs/release-process.md)
  202. - [CHANGELOG](CHANGELOG.md)
  203. - [ROADMAP](ROADMAP.md)
  204. - [CONTRIBUTING](CONTRIBUTING.md)
  205. ---
  206. ## License & Credits
  207. MIT — see [LICENSE](LICENSE).
  208. - Original MCP server by [Coding-Solo](https://github.com/Coding-Solo/godot-mcp)
  209. - GoPeak enhancements by [HaD0Yun](https://github.com/HaD0Yun)
  210. - Project visualizer inspired by [tomyud1/godot-mcp](https://github.com/tomyud1/godot-mcp)

Ratings and comments

Sign in to rate this skill.

Sign in

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