项目简介:

Godot Swift MCP 服务器是一个用 Swift 语言实现的 Model Context Protocol (MCP) 后端。它专门设计用于与 Godot 游戏引擎集成,为连接的 LLM 客户端提供标准化的上下文信息访问和功能调用能力。该服务器支持资源管理、工具注册与执行、Prompt 模板渲染等 MCP 核心功能,并通过如 WebSocket 等多种协议与客户端通信。它可以作为现有 Godot-MCP 实现的一个替代方案,尤其适用于需要在特定环境下(如 iOS/iPadOS)进行紧密集成或进程内通信的场景。

主要功能点:

  • 实现 MCP 协议: 完全兼容 Model Context Protocol,能够处理 LLM 客户端发送的 JSON-RPC 请求。
  • 集成 Godot 引擎: 专为与 Godot 游戏引擎配合设计,方便获取游戏状态、调用游戏功能等作为上下文或工具。
  • 上下文服务: 提供资源(Resources)托管与访问能力。
  • 工具调用: 支持注册和执行外部工具(Tools),供 LLM 调用扩展功能。
  • Prompt 管理: 支持定义和渲染 Prompt 模板(Prompts),优化 LLM 交互。
  • 灵活的通信: 通过可插拔的提供者架构支持多种传输协议,例如 WebSocket。
  • 多种部署方式: 可设计为在独立进程中运行,或通过特定实现(如 SwiftGodot)在 Godot 进程内运行。

安装步骤:

由于该项目使用 Swift 语言和 Swift Package Manager,标准的安装流程如下:

  1. 克隆仓库: 使用 Git 命令将仓库克隆到本地:
    git clone https://github.com/xibbon/GodotSwiftMcp.git
    cd GodotSwiftMcp
  2. 构建项目: 使用 Swift Package Manager 构建项目并生成可执行文件。具体构建命令可能取决于您的环境和需求,通常是:
    swift build -c release
    这会在 '.build/release' 目录下生成可执行文件(例如名为 'GodotSwiftMcp')。
  3. 查找可执行文件路径: 记住生成的可执行文件的完整路径,您在配置 MCP 客户端时需要用到它。

更详细和特定的构建指南请参考仓库中的 'Package.swift' 文件或其他任何提供的文档。

服务器配置:

MCP 客户端(例如 Godot 插件或独立的 LLM 应用)需要配置如何启动并连接到此服务器。配置信息通常是一个 JSON 结构,包含以下关键字段的描述:

  • 'server name': 一个用于标识此服务器的名称(字符串)。您可以自定义,例如 '"GodotSwiftMcpServer"'。
  • 'command': 启动服务器的可执行文件的完整路径(字符串)。这是您在安装步骤中找到的路径,例如 '/path/to/your/GodotSwiftMcp/.build/release/GodotSwiftMcp'。
  • 'args': 传递给服务器可执行文件的命令行参数列表(字符串数组)。例如,如果服务器监听特定端口,您可能需要在此处指定 '--port', '8080' 等参数。具体的可用参数需要查阅服务器代码或相关文档。根据 README 提及,测试时使用了 WebSocket 提供者,可能需要配置连接地址或端口等信息。

基本使用方法:

  1. 准备 Godot 环境: 确保您的 Godot 项目已经集成了兼容的 MCP 客户端(例如来自 Godot-MCP 仓库的插件)。
  2. 配置客户端: 在 Godot 项目或 LLM 应用的 MCP 客户端配置中,填入上述服务器配置信息,指定您构建好的 Godot Swift MCP 服务器的可执行文件路径和必要的启动参数。
  3. 启动服务器: 手动或由 MCP 客户端根据配置自动启动 Godot Swift MCP 服务器的可执行文件。
  4. 连接与交互: 启动 Godot 引擎,MCP 客户端将尝试连接到服务器。连接成功后,LLM 客户端即可通过 MCP 协议发送请求,利用服务器提供的上下文信息、工具和 Prompt 功能。

信息

分类

AI与计算