使用说明

项目简介

Godot MCP服务器是一个专为Godot游戏引擎设计的MCP服务器实现，它允许AI助手通过标准化的MCP协议与Godot编辑器进行通信，从而实现自动化工作流程。例如，AI助手可以利用此服务器来启动Godot编辑器、运行游戏项目、捕获调试输出、以及进行场景和资源管理等操作。这为AI驱动的游戏开发和自动化测试提供了强大的工具。

主要功能点

启动Godot编辑器: 根据项目路径启动Godot编辑器。
运行Godot项目: 在调试模式下运行指定的Godot项目，并能指定运行的场景。
获取调试输出: 实时捕获并返回Godot项目运行时的控制台输出和错误信息。
停止运行项目: 程序化停止当前正在运行的Godot项目。
获取Godot版本: 查询并返回服务器上安装的Godot引擎版本信息。
列出Godot项目: 在指定目录下搜索并列出Godot项目。
获取项目信息: 检索并返回Godot项目的元数据和结构信息。
场景管理:
- 创建新场景: 创建指定根节点类型的新Godot场景文件。
- 添加节点: 向现有场景中添加新的节点，并可自定义节点属性。
- 加载Sprite: 将纹理加载到Sprite2D节点中。
- 导出MeshLibrary: 将3D场景导出为MeshLibrary资源，用于GridMap。
- 保存场景: 保存对场景文件的更改，并支持创建场景变体。
UID管理 (Godot 4.4+):
- 获取UID: 获取Godot 4.4+项目中特定文件的UID。
- 更新项目UID: 在升级到Godot 4.4+后，通过重新保存资源来更新项目中的UID引用。

安装步骤

安装Godot引擎: 确保您的系统上已安装 Godot Engine。
安装Node.js和npm: 确保您的系统上已安装 Node.js 和 npm。

克隆仓库: 使用git克隆 'godot-mcp' 仓库到本地：

git clone https://github.com/Coding-Solo/godot-mcp.git
cd godot-mcp

安装依赖并构建: 运行以下命令安装项目依赖并构建服务器：
```
npm install
npm run build
```

服务器配置

本Godot MCP服务器需要配置到支持MCP协议的客户端中使用，例如 Cline 或 Cursor。配置的关键是提供服务器的启动命令和参数。以下是针对 Cline 和 Cursor 的配置示例，您需要根据实际情况修改路径。

Cline 配置示例

在 Cline 的 MCP 设置文件 ('~/Library/Application Support/Code/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json') 中添加如下配置：

{
  "mcpServers": {
    "godot": {  // 服务器名称，可以自定义
      "command": "node",  // 启动命令，这里使用 node
      "args": ["/absolute/path/to/godot-mcp/build/index.js"], // 启动参数，指向构建后的 index.js 文件，请替换为实际路径
      "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"
      ]
    }
  }
}

配置说明:

'"godot"': 自定义的服务器名称，在Cline中用于标识该MCP服务器。
'"command": "node"': 指定用于启动服务器的命令为 'node'，表示使用Node.js环境运行。
'"args": ["/absolute/path/to/godot-mcp/build/index.js"]': 请务必将 '/absolute/path/to/godot-mcp/build/index.js' 替换为 'godot-mcp' 项目 'build/index.js' 文件的绝对路径。 这是MCP客户端连接服务器的关键。
'"env": {"DEBUG": "true"}': 可选的环境变量配置，'DEBUG: "true"' 用于启用服务器端的详细调试日志，方便排查问题。
'"disabled": false': 确保服务器未被禁用，设置为 'false' 表示启用。
'"autoApprove": [...]': 列出自动批准执行的工具名称，当AI助手请求调用这些工具时，无需用户手动确认即可自动执行。根据需要配置您希望自动执行的工具。

Cursor 配置示例

通过 Cursor UI 配置:

打开 Cursor 设置 > Features > MCP。
点击 + Add New MCP Server 按钮。
填写表单：
- Name: 'godot' (或您喜欢的名称)
- Type: 'command'
- Command: 'node /absolute/path/to/godot-mcp/build/index.js' (请替换为实际路径)
点击 "Add"。
可能需要点击 MCP 服务器卡片右上角的刷新按钮来加载工具列表。

通过项目配置 ('.cursor/mcp.json'):

在您的项目目录下的 '.cursor/' 文件夹中创建 'mcp.json' 文件，并添加以下内容：

{
  "mcpServers": {
    "godot": { // 服务器名称，可以自定义
      "command": "node", // 启动命令，这里使用 node
      "args": ["/absolute/path/to/godot-mcp/build/index.js"], // 启动参数，指向构建后的 index.js 文件，请替换为实际路径
      "env": {
        "DEBUG": "true" // 可选：启用详细日志输出
      }
    }
  }
}

配置说明:

配置项与 Cline 类似，请务必将 '/absolute/path/to/godot-mcp/build/index.js' 替换为实际路径。

基本使用方法

配置完成后，在您的AI助手（如 Cline 或 Cursor）中，可以使用自然语言指令来调用 Godot MCP 服务器提供的工具。例如：

"启动我的Godot项目编辑器，项目路径是 '/path/to/your/godot/project'"
"运行我的Godot项目，并显示错误信息"
"获取我的Godot项目的结构信息"
"创建一个新的场景，根节点类型为 Node2D，保存在 'scenes/NewScene.tscn'"
"在我的玩家场景中添加一个新的 Sprite2D 节点，并加载角色纹理"

请参考仓库的 README.md 文件中 "Example Prompts" 章节获取更多使用示例。

重要提示:

路径配置: 请务必将配置文件中的 '/absolute/path/to/godot-mcp/build/index.js' 替换为 'godot-mcp' 项目 'build/index.js' 文件的实际绝对路径。
Godot路径: 如果Godot引擎的可执行文件不在默认路径，您可能需要设置 'GODOT_PATH' 环境变量来指定Godot可执行文件的路径。
权限: 确保运行MCP服务器的用户具有访问Godot项目文件和执行Godot引擎的权限。
Cursor Yolo Mode: 如果您使用 Cursor，可以启用 "Yolo Mode" 以自动运行 MCP 工具请求。

关键词