使用说明

项目简介

PlayCanvas Editor MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器，旨在为 PlayCanvas 编辑器提供与大型语言模型 (LLM) 集成的桥梁。它允许开发者通过自然语言指令，借助 LLM 的理解和生成能力，操控 PlayCanvas 编辑器，实现自动化工作流和更智能的开发体验。

主要功能点

资源管理：支持对 PlayCanvas 编辑器中的实体 (Entities)、资源 (Assets)、场景 (Scenes) 等进行创建、修改、删除和查询等操作。
工具扩展：预置了丰富的工具集，涵盖实体操作、资源管理、场景设置、商店资源访问等功能，并支持未来扩展更多编辑器功能。
标准化接口：采用 MCP 协议作为通信标准，确保与支持 MCP 协议的 LLM 客户端（如 Cursor 编辑器、Claude 等）无缝对接。
实时通信：通过 WebSocket 协议与客户端进行实时双向通信，即时响应 LLM 指令并返回结果。

安装步骤

安装依赖：确保已安装 Node.js 和 npm。在项目根目录下运行 'npm install' 安装所需的依赖包。
加载 Chrome 扩展（可选）：如果需要通过 Chrome 浏览器扩展与服务器交互，请按照仓库 README.md 中的 'Chrome Extension' 部分步骤加载扩展。此步骤通常用于在 PlayCanvas 编辑器网页中集成 MCP 功能。

服务器配置

MCP 服务器需要配置在 MCP 客户端中，以便客户端能够启动和连接服务器。以下是针对不同 MCP 客户端的配置示例，你需要根据实际使用的客户端进行配置。

针对 Claude Desktop / Cursor 的配置 (mcp.json 或 Claude Config)

{
  "mcpServers": {
    "playcanvas": {
      "command": "tsx",  // 启动 MCP 服务器的命令，这里使用 tsx 直接运行 TypeScript 代码
      "args": [
        "/path/to/editor-mcp-server/src/server.ts" // MCP 服务器入口文件 server.ts 的绝对路径，请替换为你的实际路径
      ]
    }
  }
}

配置说明：

'command': 指定启动 MCP 服务器的命令。'tsx' 是一个可以直接运行 TypeScript 代码的工具，确保你的环境中已安装。如果未安装，你可能需要全局安装 'npm install -g tsx'。
'args': 命令参数，这里指定了 'server.ts' 文件的绝对路径。请务必将 '/path/to/editor-mcp-server/src/server.ts' 替换为你本地 'server.ts' 文件的实际绝对路径。

重要提示：

确保你的 MCP 客户端（如 Claude 或 Cursor）已设置为使用 Agent 模式，因为 MCP 服务器通常在 Agent 模式下才能被识别和调用。
根据你的操作系统 (Windows/macOS) 和 MCP 客户端类型（Claude Desktop/Cursor），配置文件的位置和格式可能略有不同，请参考仓库 README.md 和 MCP 客户端的官方文档进行准确配置。

基本使用方法

启动 MCP 服务器：配置完成后，在 MCP 客户端中启动 PlayCanvas Editor MCP Server。通常，MCP 客户端会在需要时自动启动配置的 MCP 服务器。
连接 LLM 客户端：确保 LLM 客户端已正确配置并成功连接到 PlayCanvas Editor MCP Server。连接成功后，服务器端和客户端之间会建立 WebSocket 通信。
使用自然语言指令：在 LLM 客户端的 Agent 模式下，你可以使用自然语言指令来指示 LLM 与 PlayCanvas 编辑器进行交互。例如，你可以尝试以下指令：
- '创建一个名为 '红色方块' 的实体'
- '将场景背景颜色设置为蓝色'
- '列出所有资源'
- '从商店下载一个 3D 模型'
LLM 客户端会将你的自然语言指令转换为对 MCP 服务器特定工具的调用，从而驱动 PlayCanvas 编辑器执行相应的操作。具体的指令格式和可用的工具功能取决于 LLM 客户端的实现和 MCP 服务器提供的工具集。请参考项目文档或工具列表以获取更详细的指令信息。

关键词