Godot MCP Server v5.0

一个用于 Godot 4 + C# 项目的完整 MCP (Model Context Protocol) 服务器，允许 AI 助手通过 MCP 协议获取和修改游戏运行时的信息，包括场景树查询、信号系统调试、增强日志分析等功能。

🆕 v5.0 新功能

• ✅ 简化场景树查询 - 仅返回结构和类型,减少 90% 响应大小

• ✅ 完整信号系统 - 9 个信号工具,支持监听、连接、分析

• ✅ 增强日志系统 - 环形缓冲区 + 文件持久化 + 多维度过滤

• ✅ 48 个 MCP 工具 - 覆盖场景树、属性、资源、信号、日志

🚀 快速开始

新手？ 查看 5 分钟快速开始指南

文档导航:

• 📚 完整文档索引 - 所有文档的导航中心

• 📖 完整使用指南 - 详细的工具参考和使用示例

• 🎯 AI Agent 调试指南 - 实战调试场景

• 🌲 场景树查询工具 - 19 种查询方法

• ⚡ 信号和日志系统 - 新增 完整文档

• 🔧 项目集成指南 - 如何集成到现有项目

• 💻 开发者文档 - 架构和扩展开发

• 项目完成总结 - 实现清单和功能列表

✨ 核心功能

🌲 场景树查询 (19 个工具)

• 完整/简化场景树获取

• 模糊搜索 (名称、类型、组)

• 节点上下文 (父级、兄弟、子级)

• 多层祖先追溯

• 子树查询和统计

⚡ 信号系统 (9 个工具)

• 查询节点信号列表

• 查看信号连接关系

• 动态连接/断开信号

• 手动触发信号

• 实时监听信号事件

• 信号事件历史记录

📊 日志系统 (6 个工具)

• 环形缓冲区 (最近 1000 条)

• 自动溢出到文件

• 多维度过滤 (级别、关键字、时间)

• 日志统计和导出

• 自定义日志标记

🎮 运行时控制

• 节点属性读写

• 创建/删除节点

• 场景加载/卸载

• C# 代码执行

• 方法调用

🔍 调试工具

• 性能统计

• 资源信息

• 全局变量

• 截图功能

📦 项目结构

🛠️ 安装和使用

1. 构建 MCP 服务器

2. 配置 VSCode Copilot

在 VSCode 设置中配置 MCP 服务器:

3. 在 Godot 项目中安装插件

1. 将 GodotPlugin/McpClient.cs 复制到你的 Godot 项目

2. 在项目设置中添加为 AutoLoad:

   • 名称: McpClient

   • 路径: res://McpClient.cs

4. 运行游戏

启动游戏后,HTTP 服务器自动在 http://127.0.0.1:7777/ 启动,AI 助手即可通过 MCP 协议与游戏交互。

📝 MCP 工具总览

场景树工具 (13 个)

• get_scene_tree - 获取完整场景树 (含属性、方法、信号)

• get_scene_tree_simple - ✨ 获取简化场景树 (仅结构和类型)

• get_node_info - 获取节点详细信息

• get_node_children - 获取直接子节点列表

• get_node_parent - 获取父节点信息

• find_nodes_by_type - 按类型查找节点

• find_nodes_by_name - 按名称模糊搜索

• find_nodes_by_group - 按组查找节点

• search_nodes - 组合条件搜索 (名称+类型+组)

• get_node_ancestors - 获取多层父级链

• get_node_context - 获取节点上下文 (父、兄弟、子)

• get_node_subtree - 获取子树

• node_exists - 检查节点是否存在

• get_scene_tree_stats - 获取场景树统计

信号工具 (9 个) ✨

• get_node_signals - 获取节点的所有信号

• get_signal_connections - 查看信号连接情况

• connect_signal - 连接信号到方法

• disconnect_signal - 断开信号连接

• emit_signal - 发射信号 (测试用)

• start_signal_monitoring - 开始监听信号事件

• stop_signal_monitoring - 停止监听

• get_signal_events - 获取信号事件历史

• clear_signal_events - 清空信号事件

日志工具 (6 个) ✨

• get_logs - 获取最近日志

• get_logs_filtered - 过滤查询日志 (级别、关键字、时间)

• get_log_stats - 获取日志统计

• export_logs - 导出日志到文件

• clear_logs - 清空日志

• add_custom_log - 添加自定义日志标记

属性工具 (4 个)

• get_property - 获取节点属性值

• set_property - 设置节点属性值

• list_properties - 列出节点所有属性

• list_methods - 列出节点所有方法

方法调用工具 (2 个)

• call_method - 调用节点方法

• execute_csharp - 执行 C# 代码片段

资源工具 (5 个)

• list_resources - 列出资源目录

• load_resource - 加载资源

• get_resource_info - 获取资源详细信息

• get_global_variables - 获取全局变量

• create_node - 创建新节点

调试工具 (9 个)

• delete_node - 删除节点

• load_scene - 加载场景

• get_performance_stats - 获取性能统计

• take_screenshot - 截图

• get_time - 获取游戏时间

🎯 典型使用场景

1. 调试 UI 不更新问题

2. 性能分析

3. 查找未知节点

🔧 技术架构

v5.0 架构图

核心特性

• ✅ 完全强类型 - 工具→Client→API→Godot 全链路类型安全

• ✅ 线程安全 - 请求队列 + 主线程执行场景树操作

• ✅ Agent 友好 - 模糊搜索、简化响应、上下文查询

• ✅ 内存高效 - 环形缓冲区 + 文件溢出

• ✅ 实时监控 - 信号事件捕获 + 日志追踪

📊 技术栈

• .NET 9.0 - MCP 服务器运行时

• Godot 4.x + C# - 游戏引擎

• ModelContextProtocol SDK 0.4.0 - 官方 Microsoft MCP 实现

• Refit 8.0.0 - 类型安全 HTTP 客户端

• HTTP REST - 通信协议

• JSON - 数据序列化

📈 项目统计

• 48 个 MCP 工具 (场景树 13 + 信号 9 + 日志 6 + 属性 4 + 方法 2 + 资源 5 + 调试 9)

• 48 个 HTTP 端点 (完全对应)

• 7 个文档文件 (总计 3000+ 行)

• 2000+ 行代码 (C# + Godot)

许可证

MIT License

📋 项目状态

✅ v5.0 生产就绪 - 完整的调试系统,包含简化查询、信号监听、增强日志

完成度: 100% - 所有功能已实现并编译成功

查看 项目完成总结 了解详细的实现清单。