使用说明
项目简介
Hathora Cloud Typescript SDK 不仅是一个用于与 Hathora Cloud API 交互的客户端 SDK,它还内置了一个 MCP (Model Context Protocol) 服务器。这个 MCP 服务器可以将 SDK 中提供的各种 API 方法作为工具暴露出来,供 AI 应用(如 Claude、Cursor 等)调用。通过这个 MCP 服务器,AI 应用可以方便地访问和管理 Hathora Cloud 上的游戏服务器资源,例如创建应用、部署服务、管理游戏房间等等。
主要功能点
- 资源管理: 通过工具集成 Hathora Cloud API 提供的各种资源管理功能,例如应用管理、构建管理、部署管理、房间管理、日志查看等。
- 工具集成: 将 SDK 中的 API 方法封装成易于 AI 应用调用的工具,简化 AI 应用与 Hathora Cloud 的集成过程。
- 标准化接口: 遵循 MCP 协议标准,可以与任何兼容 MCP 协议的客户端进行通信。
- 易于安装和配置: 通过 npm 等包管理器即可安装,并提供了详细的配置说明,方便用户快速启动和使用 MCP 服务器。
安装步骤
- 确保已安装 Node.js v20 或更高版本。
- 使用 npm, pnpm, bun 或 yarn 安装 '@hathora/cloud-sdk-typescript' 包。 例如使用 npm:
npm add @hathora/cloud-sdk-typescript
服务器配置
MCP 服务器需要配置启动命令及其参数才能被 MCP 客户端调用。以下是 Claude 和 Cursor 客户端的配置示例。
Claude 配置 (claude_desktop_config.json):
{ "mcpServers": { "HathoraCloud": { "command": "npx", "args": [ "-y", "--package", "@hathora/cloud-sdk-typescript", "--", "mcp", "start", "--hathora-dev-token", "YOUR_HATHORA_DEV_TOKEN", "--org-id", "YOUR_ORG_ID", "--app-id", "YOUR_APP_ID" ] } } }
参数说明:
- 'command': 启动 MCP 服务器的命令,这里使用 'npx'。
- 'args': 传递给 'npx' 的参数列表。
- '-y --package @hathora/cloud-sdk-typescript': 使用 'npx' 安装并运行 '@hathora/cloud-sdk-typescript' 包。
- '--': 分隔 'npx' 参数和后续命令参数。
- 'mcp start': 执行 '@hathora/cloud-sdk-typescript' 包中的 'mcp start' 命令,启动 MCP 服务器。
- '--hathora-dev-token YOUR_HATHORA_DEV_TOKEN': Hathora 开发者 Token,用于 API 鉴权,请替换为你的 Hathora Dev Token。
- '--org-id YOUR_ORG_ID': Hathora 组织 ID,请替换为你的组织 ID。
- '--app-id YOUR_APP_ID': Hathora 应用 ID,请替换为你的应用 ID。
Cursor 配置 (Cursor Settings > Features > MCP Servers > Add new MCP server):
- Name: 'HathoraCloud'
- Type: 'command'
- Command:
npx -y --package @hathora/cloud-sdk-typescript -- mcp start --hathora-dev-token YOUR_HATHORA_DEV_TOKEN --org-id YOUR_ORG_ID --app-id YOUR_APP_ID
参数说明: 与 Claude 配置中的 'args' 参数说明相同。
注意: 请将 'YOUR_HATHORA_DEV_TOKEN', 'YOUR_ORG_ID', 'YOUR_APP_ID' 替换为你在 Hathora Cloud 平台上的真实信息。你可以运行 'npx -y --package @hathora/cloud-sdk-typescript -- mcp start --help' 命令查看更多服务器启动参数。
基本使用方法
- 按照上述步骤配置 MCP 客户端(Claude 或 Cursor)。
- 在 MCP 客户端中选择 "HathoraCloud" MCP 服务器。
- 使用自然语言指令,通过 MCP 客户端调用 Hathora Cloud 提供的各种工具,例如:
- "列出我的所有应用"
- "创建一个新的 Hathora 应用"
- "获取应用 'YOUR_APP_ID' 的信息"
- "查看进程 'YOUR_PROCESS_ID' 的日志"
- ... 等等。
信息
分类
开发者工具