本项目是一个遵循 Model Context Protocol (MCP) 标准的服务器,旨在作为大型语言模型 (LLM) 客户端与 PlayFab 游戏后端服务之间的桥梁。
项目简介
PlayFab MCP 服务器是一个中间件,允许支持 MCP 协议的 LLM 客户端(如 Claude Desktop, Cursor)直接通过自然语言或工具调用方式与 PlayFab 服务进行交互,例如查询游戏数据、管理玩家信息等。
主要功能点
- 搜索物品: 通过 PlayFab API 搜索游戏中的物品。
- 获取用户分段: 查询 PlayFab 中定义的玩家分段信息。
- 获取分段内玩家: 根据分段 ID 列出该分段内的玩家信息。
- 查询玩家库存: 查看指定玩家的当前库存物品列表。
- 获取玩家库存集合 ID: 列出指定玩家拥有的库存集合 ID。
- PlayFab ID 转换: 将 PlayFab ID 转换为 Title Player Account ID。
安装步骤
- 确保您的系统已安装 Node.js (版本 18 或更高)。
- 从 PlayFab Game Manager 获取您的游戏的 Title ID 和 Developer Secret Key。
- 克隆或下载本项目代码。
- 在项目根目录创建 '.env' 文件,填入您的 PlayFab 凭据:
PLAYFAB_TITLE_ID=您的 Title ID PLAYFAB_DEV_SECRET_KEY=您的 Developer Secret Key - 打开终端,切换到项目根目录,安装依赖:
npm install - 构建项目:
npm run build - 启动服务器(此命令用于测试或独立运行,通常由 MCP 客户端启动):
成功启动后,您会看到 "PlayFab Server running on stdio" 的提示信息。npm start
MCP 客户端配置
要让您的 LLM 客户端使用此服务器,您需要在客户端的配置中指定如何启动该服务器。以下是配置所需的核心信息,具体配置格式和位置请参考您使用的 LLM 客户端文档:
- 服务器名称: 您希望在客户端中显示此服务器的名称(例如 "PlayFab")。
- 启动命令 (command): 'npx' (这是一个 Node.js 工具,用于执行 npm 包命令)
- 启动参数 (args): '-y', '@akiojin/playfab-mcp-server' (这些参数告诉 npx 直接运行 playfab-mcp-server 包)
- 环境变量 (env): 需要传递 'PLAYFAB_TITLE_ID' 和 'PLAYFAB_DEV_SECRET_KEY' 这两个环境变量,值填写您的实际 PlayFab 凭据。
注意:以上信息是指导您配置 MCP 客户端,您不需要在终端中直接执行这些命令,它们将由您的 LLM 客户端在需要时自动执行。
基本使用方法
配置完成后,打开您的 LLM 客户端,激活该 MCP 服务器。然后,尝试使用自然语言提问,例如:"查询最新的 10 个物品",或 "获取玩家 '玩家PlayFabID' 的库存"。LLM 客户端将识别您的意图并调用 PlayFab MCP 服务器提供的相应工具来获取结果。
信息
分类
开发者工具