Custom MCP Template

🚀 MCP 服务器模板（create-mcp-server）

此模板可助力您快速开启一个全新的 Model Context Protocol (MCP) 服务器项目，并依据推荐实践完成配置，极大提升项目启动效率。

🚀 快速开始

创建新服务器

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

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：项目元数据和依赖项。
• sconfig.json：TypeScript 编译器选项。
• .eslintrc.json：ESLint 配置。
• .prettierrc.json：Prettier 配置。
• .gitignore：Git 忽略规则。

入门指南

1. 安装依赖项：

   npm install
   

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

   npx husky install
   

3. 以开发模式运行： （使用 s-node 和 odemon 进行自动重载）

   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，根据需要实现服务逻辑。
3. 定义工具参数： 在 src/tools/yourToolParams.ts 中导出类型定义。
4. 注册工具： 在 src/initialize.ts 中添加您的工具到 tools 数组中。
5. 运行并测试： 使用 npm run dev 启动服务器，并通过访问 /api/your_tool 测试新工具。

代码检查

1. Linting（代码检查）：

   npm run lint
   

2. Formatting（格式化）：

   npm run format
   

💡 使用建议

这些命令将帮助您保持代码的整洁和一致性，建议在开发过程中定期使用。