🚀 MCPWizard

MCPWizard 是一款命令行工具，旨在助力用户轻松创建与部署模型上下文协议（MCP）服务器，提升工作效率。

🚀 快速开始

MCPWizard 可帮助您便捷地创建和部署 MCP 服务器。首先，您需要安装该工具，然后就可以使用其丰富的功能来管理您的 MCP 服务器项目。

📦 安装指南

使用以下命令全局安装 MCPWizard：

npm install -g mcpwizard

✨ 主要特性

• 能够初始化全新的 MCP 服务器项目。
• 支持添加和管理 MCP 服务器工具。
• 可构建 MCP 服务器，方便后续部署。
• 可以生成 Claude 桌面配置文件。
• 具备检查 MCP 服务器的功能。

⚠️ 重要提示

当前版本的 MCPWizard 仅支持 MCP 协议中的工具类型。

📋 发展规划

• 未来将支持 MCP 资源。
• 计划支持 MCP 提示。
• 会增加对 MCP 传输的支持。
• 实现部署服务集成。

💻 使用示例

基础用法

初始化新项目

mcpwizard init [name] [options]

选项:

• -t, --模板 <模板>: 指定一个模板（typescript、python）。默认是"typescript"。

添加工具

mcpwizard tool add <工具名称> [options]

选项:

• -d, --描述 <描述>: 工具描述

生成Claude桌面配置

mcpwizard generate-claude-config [options]

选项:

• -o, --输出 <路径>: 输出文件路径
• -s, --服务器 <服务器...>: 要包含的服务器名称

构建您的服务器

mcpwizard build

部署您的服务器

mcpwizard deploy

检查您的服务器

mcpwizard inspect

高级用法

在实际使用中，您可以根据不同的需求灵活组合使用上述命令。例如，您可以先初始化一个新项目，然后添加所需的工具，接着构建并部署服务器，最后进行检查确保服务器正常运行。

📚 详细文档

项目结构

当运行mcpwizard init my-mcp-server时，用户将获得一个新项目，并根据选择的模板具有以下结构:

TypeScript 模板

my-mcp-server/
├── src/
│   ├── prompts/     # MCP提示定义
│   ├── resources/   # MCP资源定义
│   └── tools/       # MCP工具实现
├── .env.template    # 环境变量模板
├── package.json     # 依赖和脚本
└── tsconfig.json    # TypeScript配置

Python 模板

my-mcp-server/
├── prompts/         # MCP提示定义
├── resources/       # MCP资源定义
├── tools/           # MCP工具实现
├── .env.template    # 环境变量模板
├── requirements.txt # Python依赖项
└── server.py        # 主服务器文件

依赖

📄 许可证

本项目采用 MIT 许可证。

👥 贡献

欢迎大家为项目做出贡献！以下是 mcpwizard 包的结构:

mcpwizard/
├── bin/              # CLI入口点
│   └── mcpwizard.js  # 主CLI文件
├── src/
│   ├── commands/     # CLI命令实现
│   ├── templates/    # 项目模板（typescript、python）
│   ├── utils/        # 工具函数 
│   └── validators/   # 输入验证逻辑
├── package.json      # 包配置
└── README.md         # 此文件