GoPeak-Godot-MCP-Server

使用说明（Markdown 格式）

• 项目简介

  • 该仓库实现了一个基于 MCP 的后端服务器，用来向 LLM 客户端提供对 Godot 相关资源、工具与提示模板的统一访问。核心通过 MCP 服务器注册工具、执行函数以及路由到不同执行引擎来工作，能够支持对 Godot 项目的自动化和智能化交互。

• 主要功能点

  • 提供对 Godot 函数和工具的集中注册、查询与执行，包含 listfunc、findfunc、viewfunc、execute 等核心工具。
  • 支持多种执行引擎后端：Headless（无头 Godot CLI）、Runtime（运行时实例通信）、LSP（语言服务协同）、DAP（调试协议接入），以适配不同的自动化和开发场景。
  • JSON-RPC 交互：服务器端以 MCP 规范处理请求、返回响应并包装错误，确保与客户端有一致的数据格式。
  • 错误处理与 MCP 封装：提供对 MCP 错误的统一封装与转换，确保客户端能够稳定解析错误信息。
  • 提供工具注册区（registry）和工具执行实现（engine、daemon、mcp server），实现模块化与扩展性。

• 安装步骤

  • 安装 Node.js 环境并安装项目依赖（例如 npm install）。
  • 构建/编译项目，生成可执行的 MCP 服务器入口（如 dist/mcp/index.js 或 build/index.js，具体路径需按你的部署来确定）。
  • 启动 MCP 服务器，例如使用 Node 直接运行构建输出的入口脚本（路径请按实际构建产物调整）。
  • MCP 客户端需要向服务器提供启动命令、参数与环境变量，以建立连接。

• 服务器配置（JSON，供 MCP 客户端使用，描述服务器启动信息） { "mcpServers": { "GoPeakGodotCLI": { "command": "node", "args": ["build/index.js"], // 构建产物的入口脚本路径，请按实际部署路径调整 "env": { "GODOT_FLOW_PROJECT_PATH": "/path/to/your/godot/project", "GODOT_FLOW_GODOT_PATH": "/path/to/godot" } // 注：以上字段用于 MCP 客户端在启动时连接该 MCP 服务器。客户端本身通常不需要的具体实现细节，按实际部署调整即可。 } } }

• 基本使用方法

  • 启动 MCP 服务器后，LLM 客户端可以通过 MCP 请求调用 Godot 的工具与函数（如 listfunc、execute 等），也可通过服务器暴露的各类执行引擎完成自动化任务。
  • 结合 UI/IDE 插件、CLI 封装等客户端，能在提示驱动的工作流中实现对 Godot 项目的持续集成与自动化。

• 备注

  • 服务器实现包含完整工具注册、输入校验、错误包装与执行路径分发等核心逻辑，具备可运行性和明确的功能边界。