
Godot MCP

2025.03.23
291
JavaScript游戏开发AI辅助开发开发效率
Godot MCP 是一个基于 Model Context Protocol (MCP) 的服务器,专为 Godot 游戏引擎设计。它允许 AI 助手通过标准化接口与 Godot 编辑器交互,包括启动编辑器、运行项目、捕获调试输出和控制项目执行等功能。该工具旨在为 AI 助手提供实时反馈,帮助生成更好的代码和调试支持。
View on GitHub
Overview
基本能力
产品定位
Godot MCP 是一个连接 AI 助手与 Godot 游戏引擎的桥梁,旨在通过标准化接口提供高效的开发支持。
核心功能
- 启动 Godot 编辑器:为特定项目打开 Godot 编辑器
- 运行 Godot 项目:在调试模式下执行 Godot 项目
- 捕获调试输出:获取控制台输出和错误消息
- 控制执行:以编程方式启动和停止 Godot 项目
- 获取 Godot 版本:检索已安装的 Godot 版本
- 列出 Godot 项目:在指定目录中查找 Godot 项目
- 项目分析:获取有关项目结构的详细信息
- 场景管理:
- 创建具有指定根节点类型的新场景
- 向现有场景添加具有自定义属性的节点
- 将精灵和纹理加载到 Sprite2D 节点中
- 将 3D 场景导出为 GridMap 的 MeshLibrary 资源
- 保存场景并创建变体
- UID 管理(适用于 Godot 4.4+):
- 获取特定文件的 UID
- 通过重新保存资源更新 UID 引用
适用场景
- AI 辅助的 Godot 项目开发
- 自动化测试和调试
- 项目结构分析和优化
- 场景和资源管理
工具列表
- Godot 编辑器控制:启动和停止编辑器
- 项目运行器:执行项目并捕获输出
- 项目分析器:提供项目结构信息
- 场景编辑器:创建和管理场景
- UID 管理器:处理 Godot 4.4+ 的 UID 相关操作
常见问题解答
- Godot 未找到:设置 GODOT_PATH 环境变量指向 Godot 可执行文件
- 连接问题:确保服务器正在运行并重启 AI 助手
- 无效的项目路径:确保路径指向包含 project.godot 文件的目录
- 构建问题:运行
npm install
确保所有依赖项已安装 - Cursor 特定问题:确保 MCP 服务器在 Cursor 设置中显示并启用
使用教程
使用依赖
- Godot 引擎 安装在系统上
- Node.js 和 npm
- 支持 MCP 的 AI 助手(如 Cline、Cursor 等)
安装教程
- 克隆仓库并构建 MCP 服务器:
git clone https://github.com/Coding-Solo/godot-mcp.git
cd godot-mcp
npm install
npm run build
- 配置 AI 助手:
- Cline:编辑
~/Library/Application Support/Code/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json
文件 -
Cursor:通过 UI 或创建
.cursor/mcp.json
文件进行配置 -
可选环境变量:
GODOT_PATH
:Godot 可执行文件的路径DEBUG
:设置为 "true" 以启用详细日志记录
调试方式
- 检查服务器是否正常运行
- 查看调试日志(如果启用了 DEBUG)
- 验证 Godot 路径是否正确
- 确保项目路径有效