AI导哈

Godot引擎交互协议

一个用于Godot游戏引擎的模型上下文协议(MCP)服务器，支持启动编辑器、运行项目、捕获调试输出及控制项目执行等功能。

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

使用说明

Godot MCP

                           (((((((             (((((((
                        (((((((((((           (((((((((((
                        (((((((((((((       (((((((((((((
                        (((((((((((((((((((((((((((((((((
                        (((((((((((((((((((((((((((((((((
         (((((      (((((((((((((((((((((((((((((((((((((((((      (((((
       (((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((
     ((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((
    ((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((
      (((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((
        (((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((
         (((((((((((@@@@@@@(((((((((((((((((((((((((((@@@@@@@(((((((((((
         (((((((((@@@@,,,,,@@@(((((((((((((((((((((@@@,,,,,@@@@(((((((((
         ((((((((@@@,,,,,,,,,@@(((((((@@@@@(((((((@@,,,,,,,,,@@@((((((((
         ((((((((@@@,,,,,,,,,@@(((((((@@@@@(((((((@@,,,,,,,,,@@@((((((((
         (((((((((@@@,,,,,,,@@((((((((@@@@@((((((((@@,,,,,,,@@@(((((((((
         ((((((((((((@@@@@@(((((((((((@@@@@(((((((((((@@@@@@((((((((((((
         (((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((
         (((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((
         @@@@@@@@@@@@@((((((((((((@@@@@@@@@@@@@((((((((((((@@@@@@@@@@@@@
         ((((((((( @@@(((((((((((@@(((((((((((@@(((((((((((@@@ (((((((((
         (((((((((( @@((((((((((@@@(((((((((((@@@((((((((((@@ ((((((((((
          (((((((((((@@@@@@@@@@@@@@(((((((((((@@@@@@@@@@@@@@(((((((((((
           (((((((((((((((((((((((((((((((((((((((((((((((((((((((((((
              (((((((((((((((((((((((((((((((((((((((((((((((((((((
                 (((((((((((((((((((((((((((((((((((((((((((((((
                        (((((((((((((((((((((((((((((((((


                          /$$      /$$  /$$$$$$  /$$$$$$$
                         | $$$    /$$$ /$$__  $$| $$__  $$
                         | $$$$  /$$$$| $$  \__/| $$  \ $$
                         | $$ $$/$$ $$| $$      | $$$$$$$/
                         | $$  $$$| $$| $$      | $$____/
                         | $$\  $ | $$| $$    $$| $$
                         | $$ \/  | $$|  $$$$$$/| $$
                         |__/     |__/ \______/ |__/

用于与Godot游戏引擎交互的模型上下文协议（MCP）服务器。

简介

Godot MCP使AI代理能够启动Godot编辑器、运行项目、捕获调试输出和控制项目执行。这种直接反馈循环帮助代理了解在真实的Godot项目中哪些有效，哪些无效，从而提供更好的代码生成和调试帮助。

特性

  • 启动Godot编辑器：打开特定项目的Godot编辑器
  • 运行Godot项目：在调试模式下执行Godot项目
  • 捕获调试输出：检索控制台输出和错误消息
  • 控制执行：以编程方式启动和停止Godot项目
  • 获取Godot版本：检索已安装的Godot版本
  • 列出Godot项目：在指定目录中查找Godot项目
  • 项目分析：获取有关项目结构的详细信息
  • 场景管理:
    • 使用指定的根节点类型创建新场景
    • 将节点添加到具有可自定义属性的现有场景中
    • 将精灵和纹理加载到Sprite2D节点中
    • 将3D场景导出为GridMap的MeshLibrary资源
    • 保存带有创建变体选项的场景
  • UID管理 （适用于Godot 4.4+）：
    • 获取特定文件的UID
    • 通过重新保存资源来更新UID引用

需求

  • Godot引擎 安装在您的系统上
  • Node.js（>=18.0.0）和npm
  • 支持MCP的AI代理

快速开始

克劳德代码

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

就是这样。重新启动Claude Code，您的Godot MCP工具就可用了。

对于环境变量：

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

添加到Cline MCP设置文件(~/Library/Application Support/Code/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json):

{
  "mcpServers": {
    "godot": {
      "command": "npx",
      "args": ["@coding-solo/godot-mcp"],
      "env": {
        "DEBUG": "true"
      },
      "disabled": false,
      "autoApprove": [
        "launch_editor",
        "run_project",
        "get_debug_output",
        "stop_project",
        "get_godot_version",
        "list_projects",
        "get_project_info",
        "create_scene",
        "add_node",
        "load_sprite",
        "export_mesh_library",
        "save_scene",
        "get_uid",
        "update_project_uids"
      ]
    }
  }
}
Cursor

使用光标UI：

  1. 首选 光标设置 > 特性 > 主控程序
  2. 点击 +添加新的MCP服务器 按钮
  3. 填写表格：
    • 姓名： godot
    • 类型： command
    • 命令： npx @coding-solo/godot-mcp
  4. 点击“添加”
  5. 您可能需要按MCP服务器卡右上角的刷新按钮来填充工具列表

使用项目特定配置：

在以下位置创建文件 .cursor/mcp.json 在您的项目目录中：

{
  "mcpServers": {
    "godot": {
      "command": "npx",
      "args": ["@coding-solo/godot-mcp"],
      "env": {
        "DEBUG": "true"
      }
    }
  }
}
Other MCP Clients

对于任何兼容MCP的客户端，请使用以下配置：

{
  "mcpServers": {
    "godot": {
      "command": "npx",
      "args": ["@coding-solo/godot-mcp"],
      "env": {
        "GODOT_PATH": "/path/to/godot",
        "DEBUG": "true"
      }
    }
  }
}

环境变量

变量 描述
GODOT_PATH Godot可执行文件的路径（覆盖自动检测）
DEBUG 设置为 "true" 启用详细的服务器端调试日志记录
Building from Source 
git clone https://github.com/Coding-Solo/godot-mcp.git
cd godot-mcp
npm install
npm run build

然后将您的MCP客户端指向 build/index.js 而不是使用 npx.

建筑

Godot MCP服务器使用捆绑的GDScript方法进行复杂操作：

  1. 直接命令：启动编辑器或获取项目信息等简单操作直接使用Godot的内置CLI命令。
  2. 捆绑操作脚本：创建场景或添加节点等复杂操作使用单个全面的GDScript文件(godot_operations.gd)它处理所有操作。

捆绑的脚本接受JSON格式的操作类型和参数，允许灵活动态的操作执行，而无需为每个操作生成临时文件。

故障排除

  • 未找到Godot：设置 GODOT_PATH 将环境变量添加到Godot可执行路径
  • 连接问题：确保服务器正在运行，然后重新启动您的AI助手
  • 项目路径无效：确保路径指向包含以下内容的目录 project.godot 文件
  • 构建问题：确保通过运行安装了所有依赖项 npm install
Cursor-Specific Issues
  • 确保MCP服务器在光标设置中显示并启用（设置>MCP）
  • MCP工具只能使用Agent聊天配置文件（Cursor Pro或Business订阅）运行
  • 使用“Yolo模式”自动运行MCP工具请求

许可证

此项目根据MIT许可证获得许可-请参阅 许可证 文件以获取详细信息。

相关 MCP