Skip to content

模板概览

gm-mcp 提供了三种不同的项目模板,每种模板都针对不同的使用场景进行了优化。

模板对比

特性基础模板高级模板最小模板
复杂度中等
文件数量~15个~25个~8个
依赖数量中等
学习曲线平缓陡峭平缓
适用场景学习和开发生产环境快速原型

基础模板 (basic)

推荐用于: 学习和日常开发

特性

  • ✅ 基本的MCP服务器结构
  • ✅ TypeScript配置
  • ✅ Jest测试框架
  • ✅ ESLint代码检查
  • ✅ 示例工具(问候、计算器)

项目结构

project/
├── src/
│   ├── index.ts
│   ├── tools/
│   │   ├── hello.ts
│   │   └── calculator.ts
│   └── utils/
│       └── toolRegistry.ts
├── __tests__/
│   └── tools.test.ts
├── package.json
├── tsconfig.json
└── README.md

创建命令

bash
gm-mcp init my-project --template basic

高级模板 (advanced)

推荐用于: 生产环境和复杂项目

特性

  • ✅ 完整的项目架构
  • ✅ Winston日志系统
  • ✅ 配置管理
  • ✅ 工具注册器
  • ✅ Joi输入验证
  • ✅ 更多示例工具(文件管理、天气、数据库)

项目结构

project/
├── src/
│   ├── index.ts
│   ├── tools/
│   │   ├── hello.ts
│   │   ├── calculator.ts
│   │   ├── fileManager.ts
│   │   ├── weather.ts
│   │   └── database.ts
│   └── utils/
│       ├── logger.ts
│       ├── configManager.ts
│       └── toolRegistry.ts
├── logs/
├── config.json
├── env.example
├── package.json
├── tsconfig.json
└── README.md

创建命令

bash
gm-mcp init my-project --template advanced

最小模板 (minimal)

推荐用于: 快速原型和简单项目

特性

  • ✅ 最简化的MCP服务器
  • ✅ 单个问候工具
  • ✅ 最小依赖

项目结构

project/
├── src/
│   └── index.ts
├── package.json
├── tsconfig.json
└── README.md

创建命令

bash
gm-mcp init my-project --template minimal

如何选择模板?

选择基础模板,如果您:

  • 刚开始学习MCP
  • 需要完整的开发工具链
  • 想要一个平衡的起点

选择高级模板,如果您:

  • 构建生产级应用
  • 需要复杂的架构
  • 需要日志和配置管理
  • 团队协作开发

选择最小模板,如果您:

  • 快速验证想法
  • 构建简单工具
  • 学习MCP基础概念
  • 最小化依赖

自定义模板

您也可以创建自己的模板:

  1. templates/ 目录下创建新文件夹
  2. 添加必要的文件结构
  3. src/commands/init.ts 中添加模板选项

下一步

基于 MIT 许可证发布