Godot模型上下文协议服务器

一个为Godot引擎设计的模型上下文协议服务器,支持AI助手与Godot项目交互,提供项目管理、脚本执行、场景操作等功能。

  • by Rizzpect
  • TypeScript
  • 本地部署
  • 1 星标
  • 更新于
在 GitHub 查看 Rizzpect/Godot-MCP

使用说明

Godot MCP服务器

用于Godot引擎的全面模型上下文协议(MCP)服务器,使AI助手能够与Godot项目交互。为项目管理、脚本执行、场景操作、资产管理等提供强大的工具。

特性

  • 🚀 项目管理 -启动编辑器、运行项目、管理多个项目
  • 📜 脚本管理 -使用模板创建、读取和分析GDScript
  • 🎬 场景管理 -列出、检查、创建场景
  • 🔍 节点操作 -查找节点,获取属性
  • 📊 项目分析 -统计、未使用资产检测
  • 🎨 资产管理 -列出图像、音频、字体
  • ⚙️ 项目设置 -读取project.godot配置
  • ✅ 验证 -通过LSP验证GDScript
  • 📦 出口 -导出到Windows、Linux、macOS、Android、Web
  • 🔧 UID管理 -Godot 4.4+UID支持

需求

快速开始

# Clone and install
git clone https://github.com/godot-mcp/godot-mcp.git
cd godot-mcp
npm install
npm run build

配置

环境变量

变量 描述 默认值
GODOT_PATH Godot可执行文件的路径 自动检测
GODOT_PROJECT_PATH Godot项目路径 当前目录
GODOT_LSP_PORT LSP端口 6005
DEBUG 启用调试日志记录 false

克劳德桌面

{
  "mcpServers": {
    "godot": {
      "command": "node",
      "args": ["/path/to/godot-mcp/dist/index.js"],
      "env": {
        "GODOT_PATH": "/path/to/godot",
        "GODOT_PROJECT_PATH": "/path/to/project"
      }
    }
  }
}

克莱恩

看 configs/cline_mcp_settings.json 查看完整的自动批准列表。

光标

创建 .cursor/mcp.json 在您的项目中:

{
  "mcpServers": {
    "godot": {
      "command": "node",
      "args": ["/path/to/godot-mcp/dist/index.js"]
    }
  }
}

可用工具(35+)

项目管理

工具 说明
godot_launch_editor 启动Godot编辑器
godot_run_project 运行项目(调试/无头)
godot_stop_project 停止运行项目
godot_get_project_info 获取项目详细信息
godot_get_version 获取Godot版本
godot_list_projects 在目录中查找项目
godot_quit 退出戈多。

脚本管理

工具 说明
godot_list_scripts 列出所有.gd文件
godot_read_script 阅读脚本内容
godot_create_script 使用模板创建
godot_analyze_script 分析问题
godot_run_script 执行脚本文件
godot_run_code 执行内联代码

场景管理

工具 说明
godot_list_scenes 列出所有.tscn文件
godot_get_scene_tree 获取节点层次结构
godot_create_scene 创建新场景
godot_save_scene 保存当前场景

节点操作

工具 说明
godot_find_nodes 按名称/类型查找节点
godot_get_node_properties 获取节点属性

UID管理(Godot 4.4+)

工具 说明
godot_get_uid 获取文件的UID
godot_update_project_uids 更新UID引用

调试

工具 说明
godot_get_debug_output 捕获调试输出

项目分析

工具 说明
godot_analyze_project 获取项目统计信息
godot_find_unused_assets 查找未使用的资产

资产管理

工具 说明
godot_list_resources 列出.tres文件
godot_list_assets 列出图像、音频、字体

项目设置

工具 说明
godot_get_project_settings 阅读project.godot

验证

工具 说明
godot_validate_script 通过LSP验证
godot_check_lsp 检查LSP连接

出口

工具 说明
godot_export_project 导出到平台
godot_get_export_presets 列出导出预设

效用

工具 说明
godot_execute 任意指挥
godot_get_config 获取配置

脚本模板

创建脚本时,请使用 template 参数:

  • basic -基本节点脚本
  • node -带有@onready的节点
  • character -CharacterBody2D运动
  • resource -自定义资源
  • autoload -自动加载单例
  • state -状态模式

示例提示

"Launch the Godot editor for my project"
"Create a Player script with character template"
"Analyze my project and show statistics"
"Find all scenes in my project"
"Export my project for Windows"
"What scripts are in my project?"
"Get the scene tree of Main.tscn"

发展

npm run dev    # Development with hot reload
npm run build  # Build TypeScript
npm start      # Run production

许可证

麻省理工学院-参见 许可证