Godot MCP (模型上下文协议)

Godot引擎与AI助手之间通过模型上下文协议（MCP）进行的全面集成。此插件允许AI助手与您的Godot项目互动，提供强大的代码辅助、场景操作和项目管理能力。

功能

• 完整的Godot项目访问：AI助手可以访问并修改脚本、场景、节点和项目资源。
• 双向通信：向AI发送项目数据，并在编辑器中直接应用建议的更改。
• 命令类别：
  • 节点命令：创建、修改和管理场景中的节点。
  • 脚本命令：编辑、分析和创建GDScript文件。
  • 场景命令：操作场景及其结构。
  • 项目命令：访问项目设置和资源。
  • 编辑器命令：控制各种编辑器功能。

快速设置

1. 克隆仓库

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

2. 设置MCP服务器

cd server
npm install
npm run build
# 返回到项目根目录
cd ..

3. 设置Claude桌面

1. 编辑或创建Claude桌面配置文件：

   # 对于macOS
   nano ~/Library/Application\ Support/Claude/claude_desktop_config.json
   

2. 添加以下配置（或参考提供的claude_desktop_config.json）：

   {
     "mcpServers": {
       "godot-mcp": {
    	 "command": "node",
    	 "args": [
    	   "PATH_TO_YOUR_PROJECT/server/dist/index.js"
    	 ],
    	 "env": {
    	   "MCP_TRANSPORT": "stdio"
    	 }
       }
     }
   }
   

   注意：用您存储该仓库的实际绝对路径替换PATH_TO_YOUR_PROJECT。

3. 重启Claude桌面

4. 在Godot中打开示例项目

1. 打开Godot引擎
2. 选择“导入”并导航到克隆的仓库
3. 打开project.godot文件
4. 此示例项目中已启用MCP插件

使用Claude与MCP

设置完成后，您可以直接从Claude使用自然语言处理您的Godot项目。这里有一些示例：

示例提示

@mcp godot-mcp read godot://script/current

我需要帮助优化我的玩家移动代码。你能提出改进吗？

@mcp godot-mcp run get-scene-tree

在场景中间添加一个立方体，然后创建一个朝向立方体的摄像机。

@mcp godot-mcp read godot://scene/current

创建一个敌方AI，在巡逻点之间巡逻，并在玩家进入攻击范围时攻击玩家。

自然语言任务Claude可以执行

• “创建一个带有播放、选项和退出按钮的主要菜单”
• “为玩家角色添加碰撞检测”
• “实现昼夜循环系统”
• “重构这段代码以使用信号而不是直接引用”
• “调试为什么我的玩家角色有时会穿过地板”

可用资源和命令

资源端点：

• godot://script/current - 当前打开的脚本
• godot://scene/current - 当前打开的场景
• godot://project/info - 项目元数据和设置

命令类别：

节点命令

• get-scene-tree - 返回场景树结构
• get-node-properties - 获取特定节点的属性
• create-node - 创建新节点
• delete-node - 删除节点
• modify-node - 更新节点属性

脚本命令

• list-project-scripts - 列出项目中的所有脚本
• read-script - 读取特定脚本
• modify-script - 更新脚本内容
• create-script - 创建新脚本
• analyze-script - 提供脚本分析

场景命令

• list-project-scenes - 列出项目中的所有场景
• read-scene - 读取场景结构
• create-scene - 创建新场景
• save-scene - 保存当前场景

项目命令

• get-project-settings - 获取项目设置
• list-project-resources - 列出项目资源

编辑器命令

• get-editor-state - 获取当前编辑器状态
• run-project - 运行项目
• stop-project - 停止运行中的项目

故障排除

连接问题

• 确保在Godot的项目设置中启用了插件
• 检查Godot控制台是否有任何错误消息
• 确认当Claude桌面启动它时，服务器正在运行

插件无法工作

• 在进行任何配置更改后重新加载Godot项目
• 检查Godot控制台中的错误消息
• 确保Claude桌面配置中的所有路径都是绝对且正确的

将插件添加到您自己的Godot项目

如果您想在自己的Godot项目中使用MCP插件：

1. 将addons/godot_mcp文件夹复制到您的Godot项目的addons目录
2. 在Godot中打开您的项目
3. 转到项目 > 项目设置 > 插件
4. 启用“Godot MCP”插件

贡献

欢迎贡献！请随意提交拉取请求。

文档

如需更多详细信息，请查看docs文件夹中的文档：

• 入门指南
• 安装指南
• 命令参考
• 架构

许可证

本项目根据MIT许可证发布 - 查看LICENSE文件获取详情。