使用说明
项目简介
本项目 Godot MCP Script Integration 为 Godot 游戏引擎编辑器提供了一个 Model Context Protocol (MCP) 服务器。该服务器允许 LLM 客户端(如 Claude Desktop)访问 Godot 编辑器中当前打开的脚本以及项目中的其他脚本文件,从而为 LLM 提供代码上下文信息,实现更智能的代码辅助功能。
主要功能点
- 资源 (Resources):
- 提供 'godot://script/current' 资源,用于获取当前在 Godot 编辑器中打开的脚本内容。
- 工具 (Tools):
- 'update-current-script': 更新服务器中当前脚本的信息(路径和内容),通常由 Godot 编辑器插件调用。
- 'list-project-scripts': 列出指定 Godot 项目目录下的所有脚本文件。
- 'read-script': 读取指定路径脚本文件的内容。
安装步骤
-
进入 server 目录: 打开终端,导航到仓库的 'server' 目录:
cd /path/to/Godot-MCP/server(请将 '/path/to/Godot-MCP' 替换为你的本地仓库路径)
-
安装依赖: 运行 npm 命令安装项目依赖:
npm install -
构建服务器: 运行 npm 命令构建 TypeScript 服务器代码:
npm run build
服务器配置
为了让 MCP 客户端(例如 Claude Desktop)连接到此 MCP 服务器,您需要配置客户端。对于 Claude Desktop,您需要编辑其配置文件 'claude_desktop_config.json',添加如下服务器配置:
{ "mcpServers": { "godot-script-server": { "command": "node", "args": [ "/path/to/Godot-MCP/server/dist/index.js" ], "env": { "MCP_TRANSPORT": "stdio" } } } }
配置参数说明:
- '"godot-script-server"': 服务器名称,可以自定义,用于在 Claude Desktop 中标识该服务器。
- '"command": "node"': 启动服务器的命令,这里使用 Node.js 运行时环境。
- '"args": [...]': 启动命令的参数,指向构建后的服务器入口文件 'index.js' 的绝对路径。请务必将 '/path/to/Godot-MCP' 替换为你的本地仓库路径。
- '"env": { "MCP_TRANSPORT": "stdio" }': 设置环境变量 'MCP_TRANSPORT' 为 'stdio',指定使用标准输入输出流进行 MCP 通信,这是 Claude Desktop 使用的推荐模式。
请注意: Claude Desktop 会自动启动配置的 MCP 服务器,您无需手动运行。
基本使用方法
- 打开 Godot 项目: 使用 Godot 编辑器打开包含 'addons/mcp_integration/' 目录的项目(或者将 'addons/mcp_integration/' 插件目录复制到您的 Godot 项目中)。
- 启用插件: 在 Godot 编辑器中,进入 "项目 > 项目设置 > 插件",启用 "MCP Script Integration" 插件。
- 编辑脚本: 在 Godot 编辑器中打开和编辑 GDScript 脚本。
- 连接 Claude Desktop: 确保已配置 Claude Desktop 并重启 Claude Desktop 应用。Claude Desktop 应该会自动连接到 Godot MCP 服务器。
- 在 Claude Desktop 中使用: 在 Claude Desktop 中,您现在应该可以通过 MCP 协议访问 Godot 编辑器中当前打开的脚本内容,以便进行代码相关的对话和操作。
信息
分类
开发者工具