使用说明

项目简介

cocos-mcp 是一个基于 Model Context Protocol (MCP) 的服务器实现，旨在通过 AI 技术扩展 Cocos Creator 编辑器的功能。它允许 LLM 客户端通过标准化的 MCP 协议与 Cocos Creator 编辑器进行交互，实现自动化工作流程和智能辅助开发。

主要功能点

工具 (Tools) 注册与执行: Cocos MCP 服务器可以发现并注册由 Cocos Creator 插件提供的工具，这些工具代表了编辑器可以执行的各种操作和功能。
工具调用: 通过 MCP 协议，LLM 客户端可以调用已注册的工具，并传递参数，从而驱动 Cocos Creator 编辑器执行特定任务，例如场景编辑、资源管理、构建发布等。
与 Cocos Creator 插件通信: 服务器通过 WebSocket 与 Cocos Creator 插件通信，插件负责实际执行编辑器操作并将结果返回给服务器。

安装步骤

安装 Node.js: 确保你的系统已安装 Node.js 和 npm (Node Package Manager)。
全局安装 'cocos-mcp': 打开终端或命令提示符，运行命令 'npm install cocos-mcp -g' 全局安装 cocos-mcp 服务器。
安装 Cocos Creator 插件: 下载并安装支持 MCP 协议的 Cocos Creator 插件到你的 Cocos Creator 项目中。插件负责提供工具的具体实现和与 Cocos Creator 编辑器的交互。

服务器配置

在 MCP 客户端（例如 vscode/windsurf 等）中，配置 MCP 服务器连接信息。以下是一个示例配置，用于连接到本地运行的 'cocos-mcp' 服务器：

{
    "cocos-mcp": {
        "command": "cocos-mcp"
    }
}

'cocos-mcp': 服务器名称，可以自定义。
'command': 启动 cocos-mcp 服务器的命令。全局安装后，可以直接使用 'cocos-mcp' 命令。

基本使用方法

启动 Cocos MCP 服务器: 在终端或命令提示符中运行 'cocos-mcp' 命令启动服务器。
启动 MCP 客户端并连接服务器: 打开 MCP 客户端（如 vscode/windsurf），根据上述配置连接到 'cocos-mcp' 服务器。
刷新 MCP 服务器: 在 MCP 客户端中刷新服务器列表或手动刷新 'cocos-mcp' 服务器，客户端应该能够发现并显示由 Cocos Creator 插件提供的工具。
调用工具: 在 MCP 客户端中，可以通过自然语言指令或图形界面调用已注册的工具，驱动 Cocos Creator 编辑器执行相应操作。

关键词