快速开始

欢迎使用 GM-MCP (归梦MCP脚手架)！这是一个用于快速创建MCP TypeScript项目的脚手架工具。

什么是MCP？

MCP (Model Context Protocol) 是一个用于连接AI模型与外部数据源的开放协议。它允许AI模型安全地访问和操作各种工具、数据源和服务。

为什么选择gm-mcp？

• 🚀 快速启动：几秒钟内创建完整的MCP项目
• 📦 多种模板：基础、高级、最小三种模板可选
• 🎨 美观界面：优雅的控制台输出和加载动画
• ⚡ 交互式配置：智能的项目配置向导
• 🔧 完整工具链：集成TypeScript、测试、ESLint等

安装

全局安装

npm install -g @studiogm/gm-mcp

验证安装

gm-mcp --version

创建第一个项目

1. 交互式创建

gm-mcp init my-mcp-project

这将启动交互式向导，引导您完成项目创建：

• 选择项目模板
• 配置项目选项
• 自动安装依赖

2. 快速创建

# 使用默认配置
gm-mcp init my-project --yes

# 指定模板
gm-mcp init my-project --template advanced

3. 开始开发

cd my-mcp-project
npm run dev

项目结构

创建的项目将包含以下结构：

my-mcp-project/
├── src/
│   ├── index.ts          # 主入口文件
│   ├── tools/            # 工具定义
│   └── utils/            # 工具函数
├── dist/                 # 编译输出
├── package.json          # 项目配置
├── tsconfig.json         # TypeScript配置
└── README.md             # 项目说明

下一步

• 安装指南 - 详细的安装说明
• 基本用法 - 学习基本命令
• 高级用法 - 探索高级功能
• 模板概览 - 了解所有可用模板