使用说明

项目简介

'simple-mcp' 是一个使用 TypeScript 开发的库，旨在简化 Model Context Protocol (MCP) 服务器的创建过程。它提供了一套简洁的 API，帮助开发者快速构建符合 MCP 协议的服务端应用，专注于工具的注册和管理，并处理与 MCP 客户端的通信。

主要功能点

• 工具注册与管理: 允许开发者轻松注册和管理各种工具 (Tools)，每个工具可以定义参数和执行逻辑，供 LLM 客户端调用。
• 参数验证: 内置基于 Zod 的参数验证机制，确保工具接收到的参数符合预定义的schema，提高数据可靠性。
• 类型安全: 使用 TypeScript 开发，提供完善的类型定义，增强代码的可维护性和可读性，减少运行时错误。
• MCP 协议兼容: 完全实现了 Model Context Protocol 协议，可以与任何遵循 MCP 协议的客户端进行通信。
• Stdio 传输: 目前支持 Stdio (标准输入输出) 传输协议，方便本地开发和部署。

安装步骤

1. 确保你的开发环境已安装 Node.js 和 npm。
2. 在你的项目目录下，运行以下命令安装 'simple-mcp' 库：

   npm install simple-mcp
   

服务器配置

对于 MCP 客户端，你需要配置以下信息以连接到 'simple-mcp' 服务器。以下是一个 JSON 格式的配置示例：

{
  "serverName": "my-mcp-server",
  "command": "node",
  "args": ["path/to/your/server.js"]
}

• 'serverName': 为你的 MCP 服务器实例指定一个名称，例如 "my-mcp-server"。
• 'command': 运行服务器的命令，通常为 'node'，用于执行 JavaScript 代码。
• 'args': 传递给 'command' 的参数数组。你需要将 '"path/to/your/server.js"' 替换为你的服务器入口文件 (JavaScript 文件) 的实际路径。 例如，如果你创建了一个名为 'server.ts' 的文件并在 'dist' 目录下编译生成了 'server.js'，则路径可能类似于 '["dist/server.js"]'。 请根据你的项目实际情况调整路径。

注意： 上述配置中的 'path/to/your/server.js' 仅仅是占位符，你需要根据你实际存放编译后的 JavaScript 服务器文件的路径进行修改。例如，如果你直接运行示例代码，可能需要先编译 TypeScript 代码，然后指向编译后的 JavaScript 文件。

基本使用方法

1. 创建服务器文件: 创建一个 TypeScript 文件 (例如 'server.ts')，并引入 'McpServer' 和 'z' (Zod) 等必要的模块。
2. 初始化 MCP 服务器: 使用 'new McpServer({ name: 'your-server-name' })' 创建一个 'McpServer' 实例，并指定服务器名称。
3. 注册工具: 使用 'server.tool({...})' 方法注册工具。每个工具需要定义 'name' (工具名称), 'parameters' (使用 Zod 定义的参数 schema), 和 'execute' (工具的执行函数)。
4. 启动服务器: 调用 'server.start({ transportType: 'stdio' })' 启动服务器，目前仅支持 'stdio' 传输类型。
5. 编译和运行: 使用 TypeScript 编译器 (tsc) 将 'server.ts' 文件编译为 JavaScript 文件 (例如 'server.js')，然后使用 'node server.js' 命令运行服务器。

参考仓库的 'examples' 目录可以找到更详细的使用示例，例如 'greet.ts' (简单的问候工具) 和 'calculator.ts' (计算器工具)。