Better Godot MCP

关键词

Godot 引擎整合AI 助手资源与工具管理JSON-RPC 服务安全执行

使用说明（Markdown 格式）

  • 项目简介 Better Godot MCP 是一个基于 Model Context Protocol (MCP) 的后端服务器实现，旨在向大型语言模型（LLM）客户端提供 Godot 引擎相关的上下文信息和功能能力。核心能力包括托管与管理资源、注册并执行工具、定义和渲染 Prompt 模板等。服务器通过 JSON-RPC 与客户端通信，支持会话管理与能力声明，运行在多种传输协议下（如 STDIO、SSE、WebSocket 等）。

  • 主要功能点

    • 资源管理：列出、查询、删除资源以及导入配置等。
    • 工具注册与执行：包含“核心工具”、扩展工具、以及面向 Godot 的大量组合工具，如 scenes、nodes、scripts、shader、tilemap、audio、navigation、ui 等等。通过统一的工具注册和路由实现对外暴露的操作。
    • 场景与节点操作：对 .tscn 文件进行创建、读取信息、修改、删除、复制、设置主场景等操作。
    • Godot 版本检测与运行支持：自动检测 Godot 二进制并执行版本查询，支持无头模式脚本执行和编辑器启动等。
    • 安全性与授权：包含路径安全解析、错误处理与内容包装等机制，帮助防止潜在的内容注入和滥用。
    • 文档与帮助：通过 help 工具提供完整文档，并能按主题加载文档内容。

  • 安装步骤

    1. 获取源码 从仓库克隆代码，确保 Node.js 环境就绪。
    2. 构建与启动 使用仓库提供的构建/启动脚本或直接运行服务器入口。若使用 CLI 部署，可根据项目文档选择 Bun/NPM 等方式进行打包与执行。
    3. Godot 依赖准备 服务器会尝试检测本地 Godot 二进制文件，若未检测到需配置 GODOT_PATH 环境变量或确保系统已安装 Godot。
    4. 配置与运行 启动后服务器将通过 MCP 协议对外提供接口，客户端可通过 JSON-RPC 调用工具、查询资源、执行操作等。

  • 服务器配置（MCP 客户端使用的配置示例） 服务器端在客户端连接时需要向 MCP 服务描述服务器信息与启动参数。典型客户端配置（JSON 格式）应包含：

    • server name：better-godot
    • command：bun
    • args：["x", "@n24q02m/better-godot-mcp@latest"] 这仅是示例，实际部署可根据你的运行环境采用 Docker、Node、或其他容器化方式，以及你所选的打包/运行方案进行配置。

  • 基本使用方法

    • 通过 MCP 客户端向服务器发送请求，向服务器查询工具列表、执行具体工具、获取资源、操作场景与脚本等。
    • 使用 help 工具获取每个工具的详细文档和用法示例。
    • 服务器支持多种传输协议，开发环境下可通过 STDIO/WebSocket 等通道与客户端对接。

服务器信息

访问项目