Create MCP Server App

🚀 create-mcp-app

create-mcp-app 是一个功能强大的脚手架工具包，可用于创建符合 Model Context Protocol (MCP) 协议的应用程序，采用现代开发实践，能帮助开发者快速搭建项目。

🚀 快速开始

创建新的MCP服务器应用程序

您可以按照详细指南，使用以下命令创建一个新的MCP服务器应用程序：

npx create-mcp-server-app@latest my-mcp-server

创建新的MCP客户端应用程序

您可以按照详细指南，使用以下命令创建一个新的MCP客户端应用程序：

npx create-mcp-client-app@latest my-mcp-client

✨ 主要特性

• 🚀 可瞬时创建MCP应用程序项目。
• 📦 提供带有严格类型检查的第一类TypeScript支持。
• 🔧 采用ESLint、Prettier和Husky构建现代化开发工具链。
• 🎯 服务器端和客户端的模板均可扩展且可定制。
• 🏗️ 使用Turborepo实现高效的单体仓库架构。
• 📝 提供全面的文档和示例。
• 🔍 内置基于Jest的测试环境。
• 🛠️ 配备丰富的开发工具和实用程序。

📦 安装指南

先决条件

• Node.js 16.x或更高版本
• pnpm 7.x或更高版本

包管理

本项目使用pnpm进行包管理，您可以按照以下步骤开始开发：

# 安装依赖项
pnpm install

# 构建所有包
pnpm build

# 运行开发环境
pnpm dev

# 运行测试
pnpm test

# 检查代码
pnpm lint

📚 详细文档

项目结构

本项目使用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                  # 根包配置

贡献方式

我们欢迎您为项目贡献代码，您可以按照以下步骤进行：

1. 叉存仓库。
2. 创建功能分支（git checkout -b feature/amazing-feature）。
3. 提交更改（git commit -m '添加一些神奇的功能'）。
4. 推送到分支（git push origin feature/amazing-feature）。
5. 打开Pull Request。

请确保您：

• 遵循现有的代码风格。
• 为新功能添加测试。
• 根据需要更新文档。
• 保持提交干净且描述清晰。

问题和错误反馈

如果您发现了一个错误或有建议，可以：

• 打开一个问题
• 提交一个拉取请求

📄 许可证

本项目根据包含在LICENSE文件中的许可协议发布。