使用说明
MCP服务器生成器
用于从模板创建新MCP(模型上下文协议)服务器的交互式CLI工具。
🎯 概述
MCP服务器构建器是一个独立的工具,可帮助您快速构建新的MCP服务器,包括:
- 交互式配置
- 模板处理
- 依赖管理
- 验证和错误报告
- 愉快的日志记录和进度跟踪
🚀 快速开始
安装
# Clone the repository
git clone <repository-url>
cd mcp_server_builder
# Make scripts executable
chmod +x mcp_server_builder.sh
chmod +x mcp_server_builder.py
用法
使用Shell脚本(推荐)
./mcp_server_builder.sh
直接使用Python脚本
python3 mcp_server_builder.py
带输出目录
./mcp_server_builder.sh my_server_name
# or
python3 mcp_server_builder.py my_server_name
📋 需求
- Python 3.10+
- 点 (通常包含在Python中)
- bash (适用于shell脚本、macOS/Linux)
注: 该模板包含在此存储库中,因此不需要额外的设置!
🔧 设置
1.安装依赖项
# Install Python dependencies
pip install -r requirements.txt
# Or with uv
uv pip install -r requirements.txt
2.使脚本可执行
chmod +x mcp_server_builder.sh
chmod +x mcp_server_builder.py
3.运行生成器
# Using shell script (recommended)
./mcp_server_builder.sh
# Or using Python directly
python3 mcp_server_builder.py
注: 该模板包含在此存储库中,因此不需要额外的设置!
📖 特性
交互式配置
- 服务器名称和描述
- 资源类型选择
- 数据库类型选择
- 功能切换(RAG、API等)
- 端口和Python版本配置
模板处理
- 自动占位符替换
- 文件自定义
- 依赖关系生成
- 配置文件更新
验证
- Python版本检查
- 文件结构验证
- 语法验证
- 依赖性检查
错误报告
- 清除错误消息
- 故障排除建议
- 构建摘要
- 下一步指导
📁 项目结构
mcp_server_builder/
├── mcp_server_builder.py # Python builder script
├── mcp_server_builder.sh # Shell wrapper script
├── setup.sh # Setup script
├── README.md # This file
├── LICENSE # License file
├── .gitignore # Git ignore rules
├── requirements.txt # Python dependencies
├── pyproject.toml # Python package configuration
├── CHANGELOG.md # Version history
├── CONTRIBUTING.md # Contribution guidelines
├── template/ # MCP Server Template (included)
│ ├── mcp_server.py
│ ├── api_server.py
│ ├── core_logic.py
│ ├── init_database.py
│ ├── main.py
│ └── ...
├── docs/ # Additional documentation
│ ├── QUICKSTART.md
│ └── GIT_SETUP.md
└── tests/ # Test files
└── test_builder.py
🎨 用法示例
基本用法
$ ./mcp_server_builder.sh
╔══════════════════════════════════════════════════════════════════════════════╗
║ MCP Server Builder - Shell Wrapper ║
╚══════════════════════════════════════════════════════════════════════════════╝
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
Pre-flight Checks
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
✓ Found Python 3.13.3
✓ Found pip 24.0
✓ All pre-flight checks passed!
[Interactive builder runs...]
✓ MCP server created successfully!
带输出目录
$ ./mcp_server_builder.sh document-search
[Pre-flight checks...]
[Interactive configuration...]
✓ Server created in: document-search
🔍 运作原理
- 飞行前检查:验证Python、pip和模板
- 配置:服务器设置的交互式提示
- 模板处理:复制和自定义模板文件
- 依赖关系生成:创建requirements.txt和pyproject.toml
- 安装:可选择安装依赖项
- 验证:检查设置并报告问题
- 总结:显示已完成的操作和下一步操作
📚 文档
- README.md -此文件(概述)
- docs/QUICKSTART.md -快速入门指南
- docs/API.md文件 -API文件(如适用)
- docs/CONTRIBUTING.md -贡献指南
🛠️ 发展
运行测试
python3 test_builder.py
贡献
- 分叉存储库
- 创建要素分支
- 进行更改
- 彻底测试
- 提交拉取请求
📝 许可证
[在此处指定您的许可证]
🤝 支持
- 问题:[GitHub问题](/问题)
- 讨论:[GitHub讨论](/讨论)
- 文档:参见
docs/目录
🙏 致谢
- 为模型上下文协议(MCP)构建
- 基于MCP社区最佳实践的模板
📦 分布
作为独立工具
构建器可以分布为:
- Git仓库
- 独立脚本
- Python包(带setup.py)
安装方法
来自Git:
git clone <repository-url>
cd mcp_server_builder
./mcp_server_builder.sh
作为Python包(如果提供了setup.py):
pip install -e .
mcp-server-builder
🔗 相关项目
📊 状态
- ✅ 交互式配置
- ✅ 模板处理
- ✅ 依赖管理
- ✅ 验证
- ✅ 错误报告
- ✅ 外壳包装
- ✅ 文档
🚧 路线图
- []打包为Python包
- []添加更多数据库类型
- []支持自定义模板
- []CI/CD集成
- []Docker支持
- []Windows支持
由以下材料制成❤️ 对于MCP社区
