MCP设计文档生成器
这是一个MCP工具,用于生成具有以下组件的设计文档:
- 模板:使用占位符存储用户配置的设计文档模板
- 鼓励:定义创建绑定到模板的设计文档的步骤
- 模型调用:使用参数细化处理AI IDE调用(如Cursor)
- 存储:为不同用户存储资源
特性
- 用于配置模板和提示的Web界面
- 用于IDE集成的API
- 用户身份验证和资源管理
- Markdown模板中对PlantUML图的支持
- 共享模板的模板市场
- 用户注册和登录系统
- 用于IDE集成的全局MCP配置生成
安装
- 安装所需的依赖项:
pip install -r requirements.txt- 使用示例数据初始化数据库:
python init_sample_data.py- 将示例模板添加到公开市场:
python add_sample_templates.py用法
web界面
- 启动主web服务器:
python app.py- 打开浏览器并导航到
http://localhost:5000
- 使用示例用户登录:
- 用户名:testuser - 密码:password123
- 获取IDE的MCP配置:
- Click on "获取MCP配置" in the template market - 复制配置JSON - 将其粘贴到IDE的MCP配置中
- 浏览市场上的模板或创建自己的模板
MCP服务(FastMCP)
方式1: 使用FastMCP CLI安装
fastmcp install mcp_service.py方式2: 直接运行服务
# STDIO模式 (默认)
python mcp_service.py
# HTTP模式
python mcp_service.py --http --host 127.0.0.1 --port 8000
# SSE模式
python mcp_service.py --sse --host 127.0.0.1 --port 8001
# StreamableHTTP模式
python mcp_service.py --streamable-http --host 127.0.0.1 --port 8002方式3: 使用启动脚本 (推荐)
# 启动所有服务
python start_all_services.py
# 启动特定传输方式的MCP服务
python start_all_services.py --mcp-transport http --mcp-port 8000
# 只启动MCP服务
python start_all_services.py --no-web --mcp-transport sse --mcp-port 8001
# 只启动Web服务
python start_all_services.py --no-mcpIDE配置
根据您选择的传输方式,配置您的IDE:
STDIO模式:
{
"mcpServers": [
{
"name": "DesignMaster",
"command": "python",
"args": ["mcp_service.py"]
}
]
}HTTP/SSE模式:
{
"mcpServers": [
{
"name": "DesignMaster",
"url": "http://127.0.0.1:8000/mcp"
}
]
}项目结构
app.py:主应用程序文件mcp_service.py:FastMCP服务实施models/:数据库模型web_templates/:Web界面模板(HTML文件)templates/:模板管理Python代码prompts/:及时管理storage/:用户资源存储mcp_tools/:MCP工具实现
API终点
Web界面端点
GET /-重定向到登录或模板市场GET /login-用户登录页面POST /login-进程登录GET /register-用户注册页面POST /register-流程注册GET /templates/market-模板市场GET /templates/create-创建新模板页面POST /templates/create-流程模板创建GET /templates/-查看模板详细信息GET /mcp/config-获取全局MCP配置
MCP标准端点
GET /mcp/capabilities-MCP能力端点POST /mcp/tools-MCP工具端点GET /mcp/sse-MCP服务器发送事件端点GET /health-健康检查端点
示例模板
该系统包括公共市场中的以下示例模板:
- Web应用设计模板 -用于web应用程序设计文档
- 微服务架构模板 -用于微服务架构设计
- 移动应用模板 -用于移动应用程序设计
这些模板为创建设计文档提供了一个起点,也可以用作创建自己模板的示例。
MCP配置
该系统现在支持IDE集成的多种传输模式。为您的IDE选择合适的配置:
STDIO模式(建议本地开发)
{
"mcpServers": [
{
"name": "DesignMaster",
"command": "python",
"args": ["mcp_service.py"]
}
]
}HTTP模式
{
"mcpServers": [
{
"name": "DesignMaster",
"url": "http://127.0.0.1:8000/mcp",
"headers": {
"X-API-Key": "user-api-key"
}
}
]
}SSE模式
{
"mcpServers": [
{
"name": "DesignMaster",
"url": "http://127.0.0.1:8001/sse",
"headers": {
"X-API-Key": "user-api-key"
}
}
]
}要获取MCP配置:
- 参观模板市场
- Click on "获取MCP配置"
- 选择合适的运输方式
- 复制配置JSON
- 将其粘贴到IDE的MCP配置中
认证
该系统现在使用API密钥认证,而不是承载令牌。每个用户都有一个唯一的API密钥,可用于向MCP服务进行身份验证。API密钥是为每个用户自动生成的,可以在MCP配置页面中找到。
向MCP服务发出请求时,请将API密钥包含在 X-API-Key 头球
X-API-Key: your-api-key-here测试MCP连接
您可以使用提供的测试脚本来验证MCP连接:
# Test legacy endpoints
python test_mcp_connection.py
# Test standard MCP endpoints
python test_mcp_standard.py
# Test FastMCP service
python test_fastmcp.py这些脚本将测试:
- 健康检查端点
- 身份验证要求
- 具有适当身份验证的MCP工具端点
- 标准MCP初始化端点
- 标准MCP JSON-RPC端点
- FastMCP服务功能
