内容
# MCP Tools 开发脚手架
这是一个快速创建 MCP 工具项目的脚手架工具。它帮助您快速设置标准的 MCP 工具项目结构,支持 TypeScript,并提供 Git 仓库和 npm 发布的配置选项。
## 特性
- 交互式项目创建过程
- 支持 TypeScript/JavaScript
- 自动 Git 仓库配置
- 支持 npm 包发布
- 集成 MCP SDK
- 标准项目结构
## 安装
您可以通过两种方式使用此脚手架:
### 方法 1:使用 npx(推荐)
```bash
npx mcp-tools-cli
```
### 方法 2:全局安装
```bash
npm install -g mcp-tools-template
mcp-tools-template
```
## 使用步骤
1. 运行脚手架命令后,您需要回答一系列问题以配置您的项目:
- 项目名称:您的 MCP 工具项目名称
- 项目描述:简要项目描述
- 作者名称:项目作者
- 电子邮件地址:作者的电子邮件
- Git 仓库配置:是否使用 Git,如果使用,请提供仓库 URL
- npm 发布配置:您是否计划发布到 npm
- TypeScript 支持:是否使用 TypeScript 进行开发
2. 配置完成后,脚手架将自动:
- 创建项目目录结构
- 初始化 package.json
- 配置 TypeScript(如果选择了)
- 创建基本的 MCP 服务器代码
- 初始化 Git 仓库(如果选择了)
- 安装必要的依赖
## 项目结构
```
├── src/
│ └── mcp-server.[ts|js] # MCP 服务器入口文件
├── package.json
├── tsconfig.json # TypeScript 配置(如果使用 TS)
├── .gitignore
└── README.md
```
## 开发指南
1. 进入项目目录:
```bash
cd your-project-name
```
2. 启动开发服务器:
```bash
npm start
```
3. MCP 服务器将在 http://localhost:3000 启动
## 依赖
- @modelcontextprotocol/sdk:MCP 协议的核心 SDK
- express:Web 服务器框架
- TypeScript 相关依赖(如果选择了):
- typescript
- @types/express
- @types/node
## 发布指南
### 发布到 npm
1. 确保您已登录 npm:
```bash
npm login
```
2. 发布包:
```bash
npm publish
```
### 推送到 Git 仓库
如果您在项目创建期间配置了 Git 仓库:
```bash
git push origin main
```
## 重要说明
- 确保在发布之前您拥有正确的 npm 和 Git 权限
- 发布之前请记得更新 package.json 中的版本号
- 建议在发布之前进行全面测试
## 支持
如果您在使用此工具时遇到任何问题,请在 [GitHub 仓库](https://github.com/puchunjie/mcp-tools-cli) 提交 Issue 或 Pull Request。
## 联系
作者:puchunjie
电子邮件:puchunjie@live.com