内容
# 创建MCP应用程序
一个强大的脚手架工具包，用于使用现代开发实践创建模型上下文协议（MCP）应用程序。
## 概述
create-mcp-app是一个单仓项目，提供用于构建MCP应用程序的工具和模板。它使用现代开发实践和工具，以确保顺畅的开发体验。该项目旨在帮助开发人员快速设置并开始使用最佳实践和现代工具构建MCP应用程序。
## 功能
- 🚀 MCP应用程序的即时项目脚手架
- 📦 具有严格类型检查的一流TypeScript支持
- 🔧 使用ESLint、Prettier和Husky的现代开发工具链
- 🎯 服务器和客户端的可扩展和可自定义模板
- 🏗️ 使用Turborepo的高效开发的单仓架构
- 📝 全面的文档和示例
- 🔍 使用Jest的内置测试设置
- 🛠️ 开发工具和实用程序
## 项目结构
该项目使用Turborepo组织为单仓，包含：
```
create-mcp-app/
├── apps/ # 应用程序包
│ ├── create-mcp-server-app/ # 服务器应用程序模板
│ │ ├── src/ # 源代码
│ │ ├── boilerplate/ # 模板文件
│ │ ├── docs/ # 文档
│ │ └── dist/ # 构建输出
│ │
│ └── create-mcp-client-app/ # 客户端应用程序模板
│ ├── src/ # 源代码
│ ├── boilerplate/ # 模板文件
│ ├── docs/ # 文档
│ └── dist/ # 构建输出
│
├── packages/ # 共享包和配置
├── .vscode/ # VS Code配置
└── package.json # 根包配置
```
## 快速开始
要创建一个新的MCP服务器应用程序（[参见详细指南](apps/create-mcp-server-app/README.md)）：
```bash
npx create-mcp-server-app@latest my-mcp-server
```
<img src="packages/docs/server.gif">
要创建一个新的MCP客户端应用程序（[参见详细指南](apps/create-mcp-client-app/README.md)）：
```bash
npx create-mcp-client-app@latest my-mcp-client
```
<img src="packages/docs/client.gif">
## 开发
### 先决条件
- Node.js 16.x 或更高版本
- pnpm 7.x 或更高版本
### 包管理
该项目使用pnpm进行包管理。要开始开发：
```bash
# 安装依赖
pnpm install
# 构建所有包
pnpm build
# 运行开发环境
pnpm dev
# 运行测试
pnpm test
# 代码检查
pnpm lint
```
## 贡献
我们欢迎贡献！以下是您可以帮助的方式：
1. 分叉仓库
2. 创建功能分支（`git checkout -b feature/amazing-feature`）
3. 提交更改（`git commit -m 'Add some amazing feature'`）
4. 推送到分支（`git push origin feature/amazing-feature`）
5. 打开拉取请求
请确保：
- 遵循现有的代码风格
- 为新功能添加测试
- 根据需要更新文档
- 保持提交记录干净且描述清晰
## 问题和错误
如果您发现一个错误或有建议：
- [打开问题](https://github.com/boguan/create-mcp-app/issues)
- [提交拉取请求](https://github.com/boguan/create-mcp-app/pulls)
## 许可证
该项目根据[LICENSE](./LICENSE)文件中包含的许可证条款进行许可。
MCP 市场