使用说明

项目简介

MCP-Editor 是一个基于 Model Context Protocol (MCP) 构建的服务器，旨在连接大型语言模型 (LLM) 与 PlayCanvas 编辑器。它通过提供一系列工具，允许 LLM 以标准化的方式操作 PlayCanvas 编辑器中的 3D 场景，例如创建、删除、移动和缩放实体，以及添加组件等。

主要功能点

PlayCanvas 编辑器控制: 通过 MCP 协议，实现对 PlayCanvas 编辑器的远程控制。
实体管理工具: 提供创建、删除、列出、设置位置和缩放等实体操作工具。
组件添加工具: 支持为实体添加渲染组件 (如 Box, Capsule 等)。
WebSocket 通信: 使用 WebSocket 与 PlayCanvas 编辑器建立实时连接。
Stdio 传输: 通过 Stdio 与 MCP 客户端（如 LLM 代理）进行通信。

安装步骤

克隆仓库: 将 'mcp-editor' 仓库克隆到本地。
安装依赖: 在仓库根目录下，运行 'npm install' 安装项目依赖。

服务器配置

MCP 客户端需要配置以下信息以连接到 MCP-Editor 服务器。配置信息为 JSON 格式，通常在 MCP 客户端的配置文件中设置：

{
  "serverName": "PlayCanvas MCP Server",  // MCP 服务器的名称，用于标识和区分
  "command": "tsx",                     // 启动 MCP 服务器的命令，tsx 用于直接运行 TypeScript 文件
  "args": ["path/to/mcp-editor/src/agent.ts"] // 命令参数，指向服务器入口文件 agent.ts 的路径，请替换为实际路径
}

注意: 'path/to/mcp-editor/src/agent.ts' 需要替换为 'agent.ts' 文件在你本地文件系统中的绝对路径或相对于 MCP 客户端工作目录的路径。

基本使用方法

启动 MCP 服务器: 配置完成后，在 MCP 客户端中启动名为 "PlayCanvas MCP Server" 的服务器。客户端会执行配置的 'command' 和 'args' 来启动 MCP-Editor 服务器。
连接 PlayCanvas 编辑器: 确保 PlayCanvas 编辑器已打开，并且 'extension/content.js' (或集成了类似功能的扩展) 已加载到编辑器环境中。该脚本会尝试连接到 'ws://localhost:52000'，与 MCP-Editor 服务器建立 WebSocket 通信。
LLM 调用工具: LLM 客户端可以通过 MCP 协议调用 MCP-Editor 服务器提供的工具，例如 'create_entity'、'delete_entity' 等，从而控制 PlayCanvas 编辑器中的场景。

简而言之，你需要先安装项目依赖，然后在 MCP 客户端中配置服务器启动信息，启动服务器后，确保 PlayCanvas 编辑器端已连接，LLM 即可通过调用预设的工具来操作 PlayCanvas 编辑器。

关键词