项目简介

GDAI MCP Godot Plugin 是一个 Godot 引擎插件,其核心功能是作为一个 Model Context Protocol (MCP) 服务器运行在 Godot 编辑器内部。它使得任何支持 MCP 的 AI 客户端(如大型语言模型集成到 IDEs 或独立应用中)能够与 Godot 编辑器进行交互,远程执行命令、获取项目信息、操作场景和节点、协助调试脚本等。这极大地增强了 AI 在游戏开发流程中的自动化和辅助能力。

主要功能点

  • 自动化场景与节点操作: 通过 AI 命令生成、修改、删除 Godot 场景中的节点、资源和脚本。
  • 访问项目文件与资源: 支持在 Godot 项目的文件系统 ('res://') 中搜索文件和资源。
  • 动态属性控制: AI 可以获取或设置场景中节点的属性值。
  • 深度项目理解: 服务器能向 AI 提供关于项目结构、场景树和脚本内容的详细上下文信息。
  • GDScript 辅助与调试: 帮助 AI 理解、编写和调试 GDScript 代码,包括查看脚本错误和调试器输出。
  • 编辑器集成: 允许 AI 直接与 Godot 编辑器环境互动,实现工作流自动化。

安装步骤

  1. 将插件添加到你的 Godot 项目: 根据项目的具体指引下载或安装 GDAI MCP Godot Plugin 到你的 Godot 4.1+ 项目的 'addons/' 目录下。
  2. 在 Godot 中启用插件: 打开 Godot 编辑器,进入项目设置(Project Settings),在插件(Plugins)选项卡中找到 GDAI MCP Godot Plugin 并确保其已启用。

服务器配置

由于此 MCP 服务器是一个 Godot 插件,它运行在 Godot 编辑器进程内部。MCP 客户端需要配置如何启动这个包含插件的 Godot 编辑器进程,并与之建立通信。

在你的 MCP 客户端的配置文件中(通常是一个 JSON 或 YAML 文件),你需要添加一个 MCP 服务器的配置项,其中至少包含启动服务器的命令 ('command') 和参数 ('args')。

一个典型的配置结构可能如下所示(注意:这里仅描述需要配置的参数类型及含义,具体配置格式取决于你的 MCP 客户端):

  • 'name': 为这个 MCP 服务器连接起一个识别名称,例如 "Godot Editor"。
  • 'command': 启动 Godot 编辑器可执行文件的路径。根据你的操作系统和 Godot 安装方式,这可能是 'godot' 或 Godot 可执行文件的完整路径。
  • 'args': 一个包含启动 Godot 编辑器所需参数的列表。这些参数通常包括:
    • '--editor': 告诉 Godot 启动编辑器模式。
    • '--path': 指定你的 Godot 项目的根目录路径。你需要将此参数后的值替换为你实际的项目路径。
    • 其他参数: 某些 MCP 客户端或插件可能需要额外的参数来激活 MCP 服务器功能或指定通信方式(如 'stdio')。请查阅 GDAI MCP Godot Plugin 的详细文档以获取启动 MCP 服务器所需的特定参数。

MCP 客户端会执行你配置的 'command' 和 'args' 来启动 Godot 编辑器,而 Godot 插件会自动在其中启动 MCP 服务器并与客户端建立连接(通常通过标准输入/输出或 WebSocket)。

基本使用方法

配置好 MCP 客户端后,你可以直接在支持该客户端的 AI 界面中与 Godot 编辑器进行交互。例如,在聊天窗口中输入指令:

  • 请求 AI "列出当前场景中的所有节点"。客户端会向 Godot MCP 服务器发送请求,服务器通过插件在 Godot 中获取节点信息并返回给客户端,AI 再将信息组织后呈现给你。
  • 告诉 AI "创建一个新的 Sprite3D 节点并添加到当前场景中"。客户端会调用相应的 MCP 工具函数(由插件提供),服务器在 Godot 编辑器中执行创建和添加节点的操作。
  • 请 AI "找出当前打开脚本中的所有错误"。客户端调用工具函数,服务器分析脚本并返回错误信息。

你可以像与一个熟悉 Godot 的助手对话一样与 AI 交流,让它帮你完成编辑器内的各种任务。

信息

分类

开发者工具