GoPeak-Godot-MCP 服务器端实现

使用说明

• 项目简介
  • 本仓库实现了一个面向 MCP 的后端服务器，专注于为 AI 助手在 Godot 项目中提供上下文信息、资源访问、工具执行和提示渲染等能力。服务器通过 MCP 的标准接口处理请求、返回响应，并对多种传输方式提供支持（如标准输入输出、WebSocket、SSE 等），以便与不同的 MCP 客户端对接。
• 主要功能点
  • MCP 核心能力：资源托管与访问、工具注册与执行、Prompt 模板的定义与渲染；通过 JSON-RPC 进行请求/响应。
  • 资源与模板：托管静态资源、提供资源模板读取、以及资源内容的渲染读取。
  • 工具体系：内置大量工具定义，支持通过 MCP 调用 Godot 相关功能（编辑、运行、调试、LSP、DAP、运行时交互等），并可按需动态激活工具组。
  • Prompts 与模板：提供基于 Prompt 的模板生成和渲染，支持参数校验与结果格式化。
  • Godot 集成与可视化：通过 GodotBridge 与 Godot 编辑器插件对接，提供运行、调试、资源编辑等能力；可选的可视化界面用于映射项目结构。
• 安装步骤
  • 安装前提
    • Node.js 18+、Godot 4.x，Godot 编辑器及运行时组件（可选的 MCP 运行时 addon）。
  • 获取与安装
    • 克隆仓库后在项目根目录执行安装与构建步骤（若有提供的构建脚本，可按仓库中的 README 指引执行）。
  • 启动 MCP 服务器
    • 使用 Node 运行入口脚本（如 npm run build 后的 index.js）或通过快速启动命令：
      • npx -y gopeak
      • 或：npm install -g gopeak, 然后执行 gopeak
  • MCP 客户端配置
    • MCP 客户端需要连接到服务器；示例配置（JSON）如下，请按实际环境调整 command/args/env： { "mcpServers": { "godot": { "command": "npx", "args": ["-y", "gopeak"], "env": { "GODOT_PATH": "/path/to/godot", "GOPEAK_TOOL_PROFILE": "compact" } } } }
    • 说明：
      • 服务器名称（示例中的 "godot"）用作 MCP 客户端识别的服务名称。
      • command/args 用于启动 MCP 服务器的可执行文件及参数。
      • env 中的 GODOT_PATH 指向 Godot 可执行文件路径，GOPEAK_TOOL_PROFILE 决定工具暴露的粒度。
• 基本使用方法
  • 启动后，MCP 客户端可通过 MCP 标准请求（如资源读取、工具调用、Prompts 获取等）与服务器交互。
  • 客户端示例用法（非代码形式说明）：
    • 请求资源：读取 Godot 项目中的指定资源或信息（如场景、脚本、资源文件等）。
    • 调用工具：选择需要的工具，传入所需参数，执行 Godot 相关操作（如创建场景、编辑节点、运行项目、调试等）。
    • 获取提示：列出 Prompts、获取和渲染 Prompt 的输出，辅助设计和实现工作流。
  • 常见问题与排障
    • Godot 未找到：确保 GODOT_PATH 设置正确，或服务器自动检测到 Godot 路径。
    • MCP 客户端无法看到工具：重启 MCP 客户端，确保服务器已启动且能够对外暴露工具列表。