Mcpwizard

🚀 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         # 此文件