使用说明

项目简介

本仓库 'MCP-Godot-sdk' 是一个用于在 Godot 游戏引擎中快速构建 Model Context Protocol (MCP) 服务器应用的 SDK。它旨在简化 Godot 开发者创建能够与 LLM 客户端通信的后端服务，支持资源管理、工具扩展和 Prompt 定制，是 AIdot 多智能体框架的一个独立组件。

主要功能点

MCP 服务器基础框架: 提供了 MCP 服务器的抽象基类和 Stdio 传输协议的具体实现，方便开发者快速搭建 MCP 服务器。
工具 (Tools) 注册: 允许开发者通过装饰器简单地将 Python 函数注册为 MCP 工具，供 LLM 客户端调用，扩展 LLM 的能力。
快速开发: 专注于简化 MCP 服务器的开发流程，让开发者可以更专注于业务逻辑的实现。
Stdio 传输支持: 默认提供基于标准输入输出 (Stdio) 的服务器实现 'MCPStdioServer'，方便集成和部署。

安装步骤

下载仓库: 将 'MCP-Godot-sdk' 仓库下载到本地。
添加到 Godot 项目: 将仓库内容（例如 'mcp' 文件夹）复制到你的 Godot 项目的合适位置。由于仓库描述中提到 "This plugin is a detached part from AIdot.", 可能需要将其作为 Godot 项目的一个插件或模块引入。 (具体集成方式可能需要参考 AIdot 项目或 SDK 的更详细文档，当前仓库信息较为简洁)

服务器配置

要使 MCP 客户端连接到使用 'MCP-Godot-sdk' 创建的服务器，需要在客户端配置服务器的启动信息。以下是基于 'Demo/test.py' 示例生成的配置信息（JSON 格式）：

{
  "server name": "GodotMCP Server",
  "command": "python",
  "args": ["Demo/test.py"]
}

配置参数说明:

server name: 服务器的名称，可以自定义，用于在客户端标识服务器连接。例如: '"GodotMCP Server"'。
command: 启动服务器的命令。由于示例代码 'Demo/test.py' 是 Python 脚本，这里设置为 '"python"'，确保客户端运行环境中 'python' 命令可用。
args: 启动命令的参数列表，以数组形式提供。对于 'Demo/test.py' 示例，参数为 '["Demo/test.py"]'，指向服务器主脚本的路径。请确保此路径相对于 MCP 客户端的运行环境是正确的，或者使用绝对路径。

注意: 实际部署时，'Demo/test.py' 仅为示例，你需要根据自己的需求创建和配置你的 MCP 服务器脚本。如果你的 Python 环境或脚本路径不同，请相应地修改 'command' 和 'args' 配置。

基本使用方法

编写服务器脚本: 参考 'Demo/test.py'，使用 'FastMCP' 类创建 MCP 服务器实例，并使用 '@mcp.tool()' 装饰器注册工具函数。
运行服务器: 在命令行或终端中，使用配置信息中的 'command' 和 'args' 运行服务器脚本，例如 'python Demo/test.py'。这将启动一个基于 Stdio 的 MCP 服务器。
配置 MCP 客户端: 在 MCP 客户端中，配置上述提供的 JSON 格式的服务器连接信息，指定服务器名称、启动命令和参数。
客户端连接和交互: 启动 MCP 客户端，客户端将根据配置信息连接到运行中的 MCP 服务器，并可以通过 MCP 协议与服务器进行通信，例如调用已注册的工具。

Demo/test.py 示例运行步骤:

确保已安装 Python 环境。
打开命令行或终端，切换到 'Demo/test.py' 文件所在的目录。
运行命令 'python test.py' 启动服务器。
使用 MCP 客户端，配置连接到该服务器，即可测试工具调用等功能。

关键词