MCP Server 模板 (create-mcp-server)

此模板可帮助您基于推荐实践快速启动一个新的模型上下文协议 (MCP) 服务器项目。

用法（创建新服务器）

要创建一个名为 my-new-mcp-server 的新 MCP 服务器项目，请使用 npx 运行以下命令：

npx create-mcp-server my-new-mcp-server

(注意：如果您尚未将此软件包发布到 npm，您可能需要先在此模板目录中运行 npm link，然后使用 create-mcp-server my-new-mcp-server)

这将：

1. 创建一个名为 my-new-mcp-server 的新目录。
2. 提示您输入项目详细信息（名称、描述）。
3. 将模板文件（src、docs、配置文件等）复制到新目录中。
4. 使用您的项目详细信息更新 package.json。

初始化后，请按照终端中提供的说明进行操作：

cd my-new-mcp-server
npm install
# 查看 src/config/ConfigurationManager.ts 中的配置
# 在 src/tools/ 中添加您的工具
# 在 src/services/ 中添加您的服务
npm run dev  # 启动开发服务器

---

开发此模板（高级）

本节介绍 mcp-server-template 本身的结构和开发过程。 如果您只是使用该模板来创建自己的服务器，则通常不需要此信息。

项目结构

• /src：包含所有源代码。
  • /config：配置管理 (ConfigurationManager)。
  • /services：核心业务逻辑类。
  • /tools：MCP 工具定义和适配器 (*Tool.ts,*Params.ts)。
  • /types：TypeScript 接口和 Zod 模式。
  • /utils：共享实用程序函数（日志记录、错误等）。
  • initialize.ts：服务器实例创建和工具注册。
  • server.ts：主应用程序入口点。
• /dist：编译后的 JavaScript 输出（由 npm run build 生成）。
• package.json：项目元数据和依赖项。
• tsconfig.json：TypeScript 编译器选项。
• .eslintrc.json：ESLint 配置。
• .prettierrc.json：Prettier 配置。
• .gitignore：Git 忽略规则。

开始使用

1. 安装依赖项：

   npm install
   

2. 配置 Husky（如果需要，第一次）：

   npx husky install
   

3. 在开发模式下运行：（使用 ts-node 和 nodemon 进行自动重新加载）

   npm run dev
   

4. 构建生产版本：

   npm run build
   

5. 运行生产版本：

   npm start
   

添加新工具 (yourTool)

1. 定义类型： 使用接口创建 src/types/yourServiceTypes.ts（例如，YourServiceConfig，YourServiceData）。 从 src/types/index.ts 导出。
2. 实现服务： 使用核心逻辑类创建 src/services/YourService.ts。 从 src/services/index.ts 导出。
3. 定义工具参数： 使用 TOOL_NAME、TOOL_DESCRIPTION 和 TOOL_PARAMS（使用带有详细 .describe() 调用的 Zod）创建 src/tools/yourToolParams.ts。
4. 实现工具注册： 创建 src/tools/yourTool.ts。 导入服务和参数。 创建一个实例化服务并使用异步处理程序调用 server.tool() 的函数，该处理程序验证输入、调用服务、格式化输出并处理错误（映射到 McpError）。
5. 注册工具： 从 src/tools/index.ts 中的 registerTools 函数中导入并调用注册函数。
6. 添加配置： 如果需要，更新 src/config/ConfigurationManager.ts 以包含新服务的配置类型、默认值、getter 和 updater。
7. 添加实用程序： 如果需要，将辅助函数添加到 src/utils/ 并导出它们。
8. 编写测试： 在 src/services/ 中为服务逻辑添加单元测试，并可能在 src/tools/ 中为工具适配器添加集成测试。

Linting 和格式化

• Lint:

  npm run lint
  

• Format:

  npm run format
  

代码将在提交时通过 Husky 和 lint-staged 自动进行 linting 和格式化。