GoPeak

🌐Languages:English|한국어|日本語|Deutsch|Português|简体中文

Discord is temporarily unavailable while the invite link is refreshed. UseGitHub Discussionsfor now.

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

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

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 therelease process.

If you used the old installer,--dir,--godot, and--configureremain accepted with warnings through the2.3.xline and are planned for removal in3.0.0. The new mappings are: use Bun's global home (BUN_INSTALL) instead of a source checkout directory, putGODOT_PATHin the MCP clientenv, and use the configuration below instead of relying on installer output. During the compatibility window,--godotand--configurestill print a client snippet but never write client files. See themigration policyfor the exact contract.

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

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

- "List Godot projects in/your/projectsand show project info."
- "Createscenes/Player.tscnwith aCharacterBody2Droot and a movement script."
- "Run the project, read the debug output, and fix the top error."
- "Usetool.catalogto find animation tools, then activate the right group."

Some capabilities require extra Godot-side services. GoPeak labels these instead of pretending everything is always available:

curl -sL https://raw.githubusercontent.com/HaD0Yun/Doyunha-Gopeak/main/install-addon.sh | bash

iwr https://raw.githubusercontent.com/HaD0Yun/Doyunha-Gopeak/main/install-addon.ps1 -UseBasicParsing | iex

Then enable plugins inProject Settings → Plugins:

- godot_mcp_editorfor bridge-backed scene/resource tools
- godot_mcp_runtimefor runtime inspection, screenshots, and input workflows

Optional shell hooks for update notifications are opt-in:

gopeak setuponly modifies supported bash/zsh rc files when you run it explicitly. Installing the release asset does not add shell hooks automatically.

GoPeak supports three exposure profiles:

Set eitherGOPEAK_TOOL_PROFILEor the fallback aliasMCP_TOOL_PROFILE.

In compact mode, search withtool.catalog; matching groups auto-activate. You can also manage groups directly withtool.groups.

If your MCP client does not refresh after activation, reconnect the client or call the newly activated tool once to force a freshtools/listround-trip.

GoPeak also uses cursor-based pagination fortools/listso large profiles are not dumped into context at once. Tune it withGOPEAK_TOOLS_PAGE_SIZEwhen needed.

Bridge-backed scene tools such asadd_nodeandset_node_propertiesaccept common vector payloads for typed properties:

{ "position": { "type": "Vector2", "x": 100, "y": 200 }, "scale": { "type": "Vector2", "x": 2, "y": 2 } }

Plain{ "x": 100, "y": 200 }and[100, 200]are also coerced for commonVector2fields, but tagged values are safest across tools.

# run the globally installed CLI gopeak # run from source git clone https://github.com/HaD0Yun/Doyunha-Gopeak.git cd Doyunha-Gopeak bun ci bun run build bun run ./build/index.js # local verification bun run ci bun run test:dynamic-groups bun run test:metadata bun run test:packaging

Runtime screenshot tools (capture_screenshot,capture_viewport) use a GoPeak-managed temporary PNG file when the runtime addon supportsoutput_path, then return normal MCP image content. Older runtime addons that do not receive anoutput_pathcontinue to return inline base64 screenshots.

- Godot not found→ setGODOT_PATH.
- No MCP tools visible→ restart your MCP client.
- Need a hidden tool→ search withtool.catalogor activate a group withtool.groups.
- Project path invalid→ confirmproject.godotexists.
- Runtime tools not working→ install/enable the runtime addon and check port7777.
- Runtime screenshots time out→ update the runtime addon so screenshot commands support the managedoutput_pathflow. For slow runtime responses, raiseGOPEAK_RUNTIME_TIMEOUT_MS; older addons may still time out on large inline base64 screenshots.
- Editor bridge disconnected→ stop duplicategopeak/MCP servers that may already own bridge port6505;get_editor_statusreports bridge startup errors such asEADDRINUSE.

GoPeak treatscompactas the safe default andfull/legacyas compatibility profiles. Future hide, remove, rename, or API-contract changes must include:
- old → new mapping or an explicit no-replacement note;
- profile impact (compact,full,legacy, or opt-in group);
- alias window and planned removal timing;
- README/docs and release-note updates;
- verification provingtools/listexposure and alias behavior;
- migration prompt examples for common Godot workflows.

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.

- Documentation Map
- Architecture
- Migration Policy
- Release Process
- CHANGELOG
- ROADMAP
- CONTRIBUTING

- Original MCP server byCoding-Solo
- GoPeak enhancements byHaD0Yun
- Project visualizer inspired bytomyud1/godot-mcp

Debug your remote Node.js and Next.js applications directly from your AI IDE like Cursor.