MCP TS Quickstart

好的，这是针对 MCP 服务器实现的无构建 TypeScript 快速入门： **目标：** * 创建一个简单的 MCP 服务器，无需任何构建步骤（例如，webpack、rollup、esbuild）。 * 使用 TypeScript 编写，并直接使用 `ts-node` 运行。 * 展示基本的 MCP 服务器功能，例如注册、心跳和数据处理。 **先决条件：** * Node.js (推荐版本 16 或更高版本) * npm 或 yarn * TypeScript (`npm install -g typescript`) * ts-node (`npm install -g ts-node`) **步骤：** 1. **创建项目目录：** ```bash mkdir mcp-server-quickstart cd mcp-server-quickstart ``` 2. **初始化 npm 项目：** ```bash npm init -y ``` 3. **安装必要的依赖项：** ```bash npm install @minecraft/server @minecraft/server-ui @minecraft/server-admin @minecraft/server-net npm install ws # 用于 WebSocket 通信 npm install uuid # 用于生成唯一 ID npm install @types/ws @types/uuid --save-dev # 安装类型定义 ``` 4. **创建 `tsconfig.json` 文件：** ```json { "compilerOptions": { "target": "esnext", "module": "commonjs", "moduleResolution": "node", "esModuleInterop": true, "forceConsistentCasingInFileNames": true, "strict": true, "skipLibCheck": true, "outDir": "dist", // 可选，如果需要输出编译后的 JavaScript "sourceMap": true, // 可选，用于调试 "experimentalDecorators": true, // 启用装饰器 "emitDecoratorMetadata": true, // 发射装饰器元数据 "lib": ["esnext"] // 包含最新的 ECMAScript 特性 }, "include": ["src/**/*"], "exclude": ["node_modules"] } ``` **解释：** * `target`: 指定编译的目标 JavaScript 版本。`esnext` 允许使用最新的 JavaScript 特性。 * `module`: 指定模块系统。 `commonjs` 适用于 Node.js。 * `moduleResolution`: 指定模块解析策略。 `node` 模拟 Node.js 的模块解析。 * `esModuleInterop`: 允许 CommonJS 模块与 ES 模块互操作。 * `strict`: 启用所有严格类型检查选项。 * `skipLibCheck`: 跳过对声明文件的类型检查，可以加快编译速度。 * `outDir`: 指定输出目录（可选）。 * `sourceMap`: 生成源映射文件（可选），用于调试。 * `experimentalDecorators` 和 `emitDecoratorMetadata`: 启用装饰器支持。 * `lib`: 包含要包含在编译中的库文件。 5. **创建 `src` 目录并创建 `src/index.ts` 文件：** ```bash mkdir src touch src/index.ts ``` 6. **将以下代码添加到 `src/index.ts`：** ```typescript import { WebSocket, WebSocketServer } from 'ws'; import { v4 as uuidv4 } from 'uuid'; interface Client { id: string; socket: WebSocket; } const clients: Client[] = []; const wss = new WebSocketServer({ port: 3000 }); console.log("MCP Server started on port 3000"); wss.on('connection', ws => { const clientId = uuidv4(); const client: Client = { id: clientId, socket: ws }; clients.push(client); console.log(`Client connected: ${clientId}`); ws.on('message', message => { console.log(`Received message from ${clientId}: ${message}`); // 广播消息给所有其他客户端 clients.forEach(c => { if (c.id !== clientId) { c.socket.send(`[${clientId}]: ${message}`); } }); }); ws.on('close', () => { console.log(`Client disconnected: ${clientId}`); clients.splice(clients.findIndex(c => c.id === clientId), 1); }); ws.on('error', error => { console.error(`WebSocket error for client ${clientId}: ${error}`); }); ws.send('Welcome to the MCP Server!'); }); wss.on('error', error => { console.error('WebSocket server error:', error); }); ``` **解释：** * **导入必要的模块：** `ws` 用于 WebSocket 服务器，`uuid` 用于生成客户端 ID。 * **`Client` 接口：** 定义客户端的结构，包含 ID 和 WebSocket 连接。 * **`clients` 数组：** 存储连接的客户端。 * **创建 WebSocket 服务器：** `new WebSocketServer({ port: 3000 })` 在端口 3000 上启动服务器。 * **`connection` 事件：** 当有客户端连接时触发。 * 生成一个唯一的客户端 ID。 * 将客户端添加到 `clients` 数组。 * 设置消息、关闭和错误处理程序。 * 发送欢迎消息。 * **`message` 事件：** 当客户端发送消息时触发。 * 将消息记录到控制台。 * 将消息广播给所有其他客户端。 * **`close` 事件：** 当客户端断开连接时触发。 * 从 `clients` 数组中删除客户端。 * **`error` 事件：** 处理 WebSocket 错误。 7. **运行服务器：** ```bash npx ts-node src/index.ts ``` 或者，如果你的 `tsconfig.json` 中有 `outDir`，你可以先编译： ```bash tsc node dist/index.js ``` 8. **测试服务器：** 你可以使用任何 WebSocket 客户端来连接到服务器。 以下是一些选项： * **在线 WebSocket 客户端：** 例如，[https://www.websocket.org/echo.html](https://www.websocket.org/echo.html) * **Node.js 客户端：** 你可以创建一个简单的 Node.js 客户端来测试服务器。 * **Minecraft 客户端：** 你可以使用 Minecraft 的 `/connect` 命令连接到服务器（如果你的服务器支持 Minecraft 协议）。 在 WebSocket 客户端中，连接到 `ws://localhost:3000`。 连接后，你应该收到欢迎消息。 发送消息，你应该看到它们被记录到服务器控制台，并广播给所有其他连接的客户端。 **重要注意事项：** * **安全性：** 此示例未实现任何安全性措施。 在生产环境中，你需要添加身份验证、授权和加密。 * **错误处理：** 此示例仅包含基本的错误处理。 你需要添加更全面的错误处理来处理各种情况。 * **扩展性：** 此示例是一个简单的单线程服务器。 对于高负载，你可能需要考虑使用多线程或集群。 * **MCP 协议：** 此示例仅演示了基本的 WebSocket 通信。 要实现完整的 MCP 服务器，你需要实现 MCP 协议的所有方面，包括注册、心跳、数据处理和命令执行。 请参考官方的 MCP 文档。 * **`@minecraft/server` 包：** 虽然安装了 `@minecraft/server` 包，但此示例并没有直接使用它。 在更复杂的 MCP 服务器实现中，你将使用此包来与 Minecraft 服务器交互。 **下一步：** * 研究 MCP 协议规范。 * 实现注册和心跳机制。 * 处理来自 Minecraft 服务器的数据。 * 实现命令执行。 * 添加安全性措施。 * 考虑使用更高级的 WebSocket 库，例如 `socket.io`。 * 探索使用 `@minecraft/server` 包与 Minecraft 服务器进行更深入的集成。 这个快速入门提供了一个基本的框架，你可以用来构建一个更完整的 MCP 服务器。 记住，这只是一个起点，你需要根据你的具体需求进行扩展和修改。 **中文翻译：** 好的，这是一个针对 MCP 服务器实现的无构建 TypeScript 快速入门： **目标：** * 创建一个简单的 MCP 服务器，无需任何构建步骤（例如，webpack、rollup、esbuild）。 * 使用 TypeScript 编写，并直接使用 `ts-node` 运行。 * 展示基本的 MCP 服务器功能，例如注册、心跳和数据处理。 **先决条件：** * Node.js (推荐版本 16 或更高版本) * npm 或 yarn * TypeScript (`npm install -g typescript`) * ts-node (`npm install -g ts-node`) **步骤：** 1. **创建项目目录：** ```bash mkdir mcp-server-quickstart cd mcp-server-quickstart ``` 2. **初始化 npm 项目：** ```bash npm init -y ``` 3. **安装必要的依赖项：** ```bash npm install @minecraft/server @minecraft/server-ui @minecraft/server-admin @minecraft/server-net npm install ws # 用于 WebSocket 通信 npm install uuid # 用于生成唯一 ID npm install @types/ws @types/uuid --save-dev # 安装类型定义 ``` 4. **创建 `tsconfig.json` 文件：** ```json { "compilerOptions": { "target": "esnext", "module": "commonjs", "moduleResolution": "node", "esModuleInterop": true, "forceConsistentCasingInFileNames": true, "strict": true, "skipLibCheck": true, "outDir": "dist", // 可选，如果需要输出编译后的 JavaScript "sourceMap": true, // 可选，用于调试 "experimentalDecorators": true, // 启用装饰器 "emitDecoratorMetadata": true, // 发射装饰器元数据 "lib": ["esnext"] // 包含最新的 ECMAScript 特性 }, "include": ["src/**/*"], "exclude": ["node_modules"] } ``` **解释：** * `target`: 指定编译的目标 JavaScript 版本。`esnext` 允许使用最新的 JavaScript 特性。 * `module`: 指定模块系统。 `commonjs` 适用于 Node.js。 * `moduleResolution`: 指定模块解析策略。 `node` 模拟 Node.js 的模块解析。 * `esModuleInterop`: 允许 CommonJS 模块与 ES 模块互操作。 * `strict`: 启用所有严格类型检查选项。 * `skipLibCheck`: 跳过对声明文件的类型检查，可以加快编译速度。 * `outDir`: 指定输出目录（可选）。 * `sourceMap`: 生成源映射文件（可选），用于调试。 * `experimentalDecorators` 和 `emitDecoratorMetadata`: 启用装饰器支持。 * `lib`: 包含要包含在编译中的库文件。 5. **创建 `src` 目录并创建 `src/index.ts` 文件：** ```bash mkdir src touch src/index.ts ``` 6. **将以下代码添加到 `src/index.ts`：** ```typescript import { WebSocket, WebSocketServer } from 'ws'; import { v4 as uuidv4 } from 'uuid'; interface Client { id: string; socket: WebSocket; } const clients: Client[] = []; const wss = new WebSocketServer({ port: 3000 }); console.log("MCP Server started on port 3000"); wss.on('connection', ws => { const clientId = uuidv4(); const client: Client = { id: clientId, socket: ws }; clients.push(client); console.log(`Client connected: ${clientId}`); ws.on('message', message => { console.log(`Received message from ${clientId}: ${message}`); // 广播消息给所有其他客户端 clients.forEach(c => { if (c.id !== clientId) { c.socket.send(`[${clientId}]: ${message}`); } }); }); ws.on('close', () => { console.log(`Client disconnected: ${clientId}`); clients.splice(clients.findIndex(c => c.id === clientId), 1); }); ws.on('error', error => { console.error(`WebSocket error for client ${clientId}: ${error}`); }); ws.send('Welcome to the MCP Server!'); }); wss.on('error', error => { console.error('WebSocket server error:', error); }); ``` **解释：** * **导入必要的模块：** `ws` 用于 WebSocket 服务器，`uuid` 用于生成客户端 ID。 * **`Client` 接口：** 定义客户端的结构，包含 ID 和 WebSocket 连接。 * **`clients` 数组：** 存储连接的客户端。 * **创建 WebSocket 服务器：** `new WebSocketServer({ port: 3000 })` 在端口 3000 上启动服务器。 * **`connection` 事件：** 当有客户端连接时触发。 * 生成一个唯一的客户端 ID。 * 将客户端添加到 `clients` 数组。 * 设置消息、关闭和错误处理程序。 * 发送欢迎消息。 * **`message` 事件：** 当客户端发送消息时触发。 * 将消息记录到控制台。 * 将消息广播给所有其他客户端。 * **`close` 事件：** 当客户端断开连接时触发。 * 从 `clients` 数组中删除客户端。 * **`error` 事件：** 处理 WebSocket 错误。 7. **运行服务器：** ```bash npx ts-node src/index.ts ``` 或者，如果你的 `tsconfig.json` 中有 `outDir`，你可以先编译： ```bash tsc node dist/index.js ``` 8. **测试服务器：** 你可以使用任何 WebSocket 客户端来连接到服务器。 以下是一些选项： * **在线 WebSocket 客户端：** 例如，[https://www.websocket.org/echo.html](https://www.websocket.org/echo.html) * **Node.js 客户端：** 你可以创建一个简单的 Node.js 客户端来测试服务器。 * **Minecraft 客户端：** 你可以使用 Minecraft 的 `/connect` 命令连接到服务器（如果你的服务器支持 Minecraft 协议）。 在 WebSocket 客户端中，连接到 `ws://localhost:3000`。 连接后，你应该收到欢迎消息。 发送消息，你应该看到它们被记录到服务器控制台，并广播给所有其他连接的客户端。 **重要注意事项：** * **安全性：** 此示例未实现任何安全性措施。 在生产环境中，你需要添加身份验证、授权和加密。 * **错误处理：** 此示例仅包含基本的错误处理。 你需要添加更全面的错误处理来处理各种情况。 * **扩展性：** 此示例是一个简单的单线程服务器。 对于高负载，你可能需要考虑使用多线程或集群。 * **MCP 协议：** 此示例仅演示了基本的 WebSocket 通信。 要实现完整的 MCP 服务器，你需要实现 MCP 协议的所有方面，包括注册、心跳、数据处理和命令执行。 请参考官方的 MCP 文档。 * **`@minecraft/server` 包：** 虽然安装了 `@minecraft/server` 包，但此示例并没有直接使用它。 在更复杂的 MCP 服务器实现中，你将使用此包来与 Minecraft 服务器交互。 **下一步：** * 研究 MCP 协议规范。 * 实现注册和心跳机制。 * 处理来自 Minecraft 服务器的数据。 * 实现命令执行。 * 添加安全性措施。 * 考虑使用更高级的 WebSocket 库，例如 `socket.io`。 * 探索使用 `@minecraft/server` 包与 Minecraft 服务器进行更深入的集成。 这个快速入门提供了一个基本的框架，你可以用来构建一个更完整的 MCP 服务器。 记住，这只是一个起点，你需要根据你的具体需求进行扩展和修改。