本页目录

Godot MCP 服务器(godot-mcp)

godot-mcp · Coding-Solo/godot-mcp

godot-mcp 是一个面向 Godot 游戏引擎的 MCP(Model Context Protocol)服务器。按仓库描述,它提供启动 Godot 编辑器、运行项目、捕获调试输出等工具,供支持 MCP 的 AI 客户端调用;README 徽章显示其与 Node.js、TypeScript 相关。具...

卡牌 桌面游戏 多人对战 无明确引擎 JavaScript 游戏状态管理 网络联机 UI 系统 中级
★ Stars 6,688 Forks 542 License MIT 更新 2026-11-17

国内开发环境适配

Windows
未知
Linux
未知
macOS
未知
引擎 / 框架:无明确引擎 暂无中文教程标记 未标记站长实测
通过 npx 从 npm registry 拉取 @coding-solo/godot-mcp,国内网络可能需要配置 npm 镜像或代理;同时需在本地自行安装 Godot 引擎,并用 GODOT_PATH 指定可执行文件路径。具体网络与版本兼容情况待核验。

中文项目介绍

godot-mcp 是一个遵循 Model Context Protocol(MCP)规范的服务器实现,作用对象是 Godot 游戏引擎。它的目标并不是直接生成游戏,而是把 Godot 编辑器与项目运行过程变成 AI 代理可以调用的工具集:代理可以启动编辑器、以调试模式跑起项目、读取控制台输出与错误信息,并通过启停操作控制执行流程。README 把这种能力描述为「直接反馈闭环」——代理能亲眼看到自己在真实 Godot 项目里写的代码是否生效、哪里报错,从而改进代码生成与调试辅助的质量。

从仓库徽章与描述看,项目以 Node.js 与 TypeScript 生态实现(仓库主语言标记为 JavaScript),通过 npx @coding-solo/godot-mcp 即可被客户端拉起,无需在本地长期驻留服务。

核心功能

启动 Godot 编辑器

为指定项目打开 Godot 编辑器界面。

运行 Godot 项目

以 debug 模式执行项目。

捕获调试输出

取回控制台输出与错误消息。

控制执行

以程序化方式启动与停止 Godot 项目。

查询 Godot 版本

获取已安装的 Godot 版本。

项目列表

在指定目录中查找 Godot 项目。

项目分析

获取项目结构的详细信息。

场景管理

以指定根节点类型新建场景;向已有场景添加节点并自定义属性;为 Sprite2D 节点加载精灵与纹理;把 3D 场景导出为可供 GridMap 使用的 MeshLibrary 资源;保存场景,并可选择创建变体。

UID 管理(Godot 4.4+)

获取指定文件的 UID;通过重新保存资源来更新 UID 引用。

技术架构分析

架构说明

README 说明服务器对复杂操作采用「打包 GDScript」的方式,分两层:

  • 直接命令:启动编辑器、读取项目信息这类简单操作,直接调用 Godot 内置 CLI。
  • 打包操作脚本:创建场景、添加节点等复杂操作,统一交给一个综合性的 GDScript 文件 godot_operations.gd 处理。

该脚本以 JSON 形式接收操作类型与参数,因此可以在不为每种操作生成临时文件的前提下,动态执行多种操作。

补充说明

环境要求

使用前需要准备三样东西:

  1. 在系统中安装 Godot Engine;
  2. Node.js(README 标注 >= 18.0.0)与 npm;
  3. 一个支持 MCP 的 AI 代理客户端。

快速开始

在 Claude Code 中只需一条命令注册服务器:

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

重启 Claude Code 后即可使用相关工具。若需要指定引擎路径或打开调试日志,可附加环境变量:

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

其他客户端采用通用 MCP 配置格式,命令为 npx,参数为 @coding-solo/godot-mcp,并在 env 中按需填写 GODOT_PATH 与 DEBUG。README 分别给出了 Cline(写入 cline_mcp_settings.json,含 autoApprove 工具白名单)与 Cursor(设置界面手动添加,或在项目内创建 .cursor/mcp.json)的具体步骤。

若希望从源码使用,可克隆仓库后执行 npm install 与 npm run build,再把 MCP 客户端指向 build/index.js,替代 npx 方式。

环境变量

变量 说明
GODOT_PATH Godot 可执行文件路径,用于覆盖自动探测结果
DEBUG 设为 "true" 时开启服务器端详细调试日志

常见问题排查

  • 找不到 Godot:设置 GODOT_PATH 指向 Godot 可执行文件。
  • 连接异常:确认服务器已运行,并重启 AI 助手。
  • 项目路径无效:路径必须指向包含 project.godot 文件的目录。
  • 构建失败:执行 npm install 确保依赖完整。
  • Cursor 相关:确认 MCP 服务器在设置中已启用;MCP 工具需在 Agent 聊天模式下使用(Cursor Pro 或 Business 订阅);可用 Yolo Mode 自动执行工具请求。

许可证

本项目采用 MIT 许可证,详见仓库中的 LICENSE 文件。

开源许可证与版权说明

许可证标识:MIT。源码、资源与依赖许可可能不同,请以官方仓库为准。本站仅做索引,不托管源码。

相似项目