使用说明
GM-MCP (归梦MCP脚手架)
一个用于快速创建MCP TypeScript项目的脚手架工具。
功能特性
- 🚀 快速初始化MCP TypeScript项目
- 📦 多种项目模板（基础、高级、最小）
- 🎨 美观的控制台输出
- ⚡ 交互式项目配置
- 🔧 自动依赖安装
- 📚 完整的帮助系统
- 🔄 版本检查和更新功能
安装
npm install -g @studiogm/gm-mcp
使用方法
初始化新项目
# 交互式创建项目
gm-mcp init my-mcp-project
# 使用指定模板
gm-mcp init my-project --template advanced
# 跳过确认，使用默认配置
gm-mcp init my-project --yes
查看帮助
gm-mcp --help
gm-mcp help
查看版本
gm-mcp version
检查更新
gm-mcp update
项目模板
基础模板 (basic)
- 基本的MCP服务器结构
- TypeScript配置
- 测试框架
- ESLint代码检查
- 示例工具（问候、计算器）
高级模板 (advanced)
- 完整的项目架构
- 日志系统
- 配置管理
- 工具注册器
- 输入验证
- 更多示例工具
最小模板 (minimal)
- 最简化的MCP服务器
- 单个问候工具
- 最小依赖
开发
构建项目
npm run build
开发模式
npm run dev
运行
npm start
技术栈
- TypeScript - 类型安全的JavaScript
- Commander.js - 命令行界面
- Chalk - 终端字符串样式
- Ora - 优雅的终端加载器
- Inquirer - 交互式命令行提示
- fs-extra - 增强的文件系统操作
许可证
MIT
贡献
欢迎提交Issue和Pull Request！
