Godot引擎AI助手控制服务器

一个为AI助手(如Claude Code、Cursor、Codex等)提供控制和访问Godot引擎功能的服务器,支持错误捕获、场景管理和远程连接,实现实时构建和调试。

  • by LeeSinLiang
  • JavaScript
  • 本地部署
  • 11 星标
  • 更新于
在 GitHub 查看 LeeSinLiang/godot-mcp

使用说明

Godot MCP服务器

用于AI助手(Claude Code、Cursor、Codex等)控制和访问Godot引擎的MCP服务器:捕获编辑器中的错误、管理场景和远程连接,允许实时构建和调试-与您的Godot编辑器同步。

设置

步骤1:安装godot-mcp(一次性)

git clone https://github.com/LeeSinLiang/godot-mcp.git ~/tools/godot-mcp
cd ~/tools/godot-mcp
npm install
npm run build
npm link

步骤2:配置您的Godot项目(每个项目)

cd ~/my-games/your-godot-project
godot-mcp-init

该工具将:

  1. 询问您的Godot可执行路径
  2. 选择要配置的客户端(克劳德桌面、克劳德代码、光标)
  3. 自动创建配置文件

就是这样! 开始在Cursor或Claude Code中使用AI辅助。

特性

  • 项目管理:启动编辑器,运行/停止项目,列出/检查Godot项目
  • 场景编辑:创建场景、添加/配置节点、加载精灵、导出网格库
  • 远程调试(推荐):连接到Godot编辑器的远程调试器,在编辑器中运行时捕获实时输出
  • 调试输出:从运行的项目中获取打印语句、错误和警告
  • 交叉平台的:Windows、macOS、Linux支持

可用的MCP工具

远程调试工作流(推荐)

在AI的帮助下,与Godot编辑器无缝协作:

  1. connect_remote_debugger -连接到Godot编辑器的远程调试器(默认端口6006/6007)
  2. 按 F5 在Godot编辑器中运行您的项目
  3. get_remote_debug_output -获取实时打印报表、错误和警告
  4. 在人工智能的帮助下进行更改,并立即在编辑器中进行测试

此工作流允许您:

  • 在Godot编辑器中编写具有语法高亮显示和自动补全功能的代码
  • 使用F5运行和调试,同时AI监控输出并建议修复
  • 无盲编码-实时查看发生的事情

所有可用工具

  • 调试和远程: connect_remote_debugger, get_remote_debug_output, disconnect_remote_debugger, get_debug_output, capture_screenshot
  • 项目管理: launch_editor, run_project, stop_project, list_projects, get_project_info, get_godot_version
  • 场景编辑: create_scene, add_node, load_sprite, save_scene, export_mesh_library
  • UID管理(Godot 4.4+): get_uid, update_project_uids

Godot可执行路径示例

窗户: C:\Program Files\Godot\Godot.exe 或 C:\Downloads\Godot_v4.5.1-stable_win64.exe\Godot_v4.5.1-stable_win64.exe

macOS: /Applications/Godot.app/Contents/MacOS/Godot

Linux: /usr/bin/godot 或 /usr/local/bin/godot

故障排除

“连接工具失败”或MCP服务器无法启动

最常见的原因: 配置中的Godot可执行文件路径错误。

解决方案:

  1. 通过运行以下命令验证您的Godot路径: "<your-godot-path>" --version

  2. 更新配置文件中的路径:

    • 克劳德代码: 编辑 .mcp.json 在您的项目目录中
    • 光标: 编辑 .cursor/mcp.json 在您的项目目录中
    • 克劳德桌面: 检查配置 %APPDATA%\Claude\ (Windows)或 ~/Library/Application Support/Claude/ (macOS)
  3. 更新配置后重新启动IDE/应用程序

检查日志:

  • 光标: 输出面板→ “MCP日志”(Ctrl+Shift+U)
  • 克劳德代码: 终端输出或MCP日志

手动配置

如果您更喜欢手动设置,请创建配置文件:

克劳德代码 - .mcp.json 在项目目录中:

{
  "mcpServers": {
    "godot": {
      "command": "node",
      "args": ["/path/to/godot-mcp/build/index.js"],
      "env": { "GODOT_PATH": "/path/to/godot/executable" }
    }
  }
}

光标 - .cursor/mcp.json 在项目目录中(格式与上述相同)

克劳德桌面版 - %APPDATA%\Claude\claude_desktop_config.json (Windows)或 ~/Library/Application Support/Claude/claude_desktop_config.json (macOS):

{
  "mcpServers": {
    "godot": {
      "command": "node",
      "args": ["/path/to/godot-mcp/build/index.js"],
      "env": { "GODOT_PATH": "/path/to/godot/executable" }
    }
  }
}

发展

npm run build      # Build the project
npm run watch      # Watch mode for development
npm run inspector  # Test with MCP inspector