内容
# BMAD MCP Server
一个模型上下文协议([MCP](https://modelcontextprotocol.io/))服务器,公开了[BMAD](https://github.com/bmadcode/BMAD-METHOD)(突破性敏捷AI驱动开发方法)方法论,作为AI系统的标准化工具。
## 概述
BMAD MCP Server通过模型上下文协议标准,将经过验证的BMAD方法论与更广泛的AI生态系统连接起来。它使任何兼容MCP的AI系统能够利用结构化的项目开发工作流程,包括:
- **项目规划**:生成项目简报和全面的PRD(产品需求文档)。
- **架构设计**:创建技术和前端架构。
- **故事管理**:生成和验证可开发的用户故事。
- **质量保证**:运行BMAD检查清单和验证工具。
## 特性
- 🔧 **9个BMAD工具**:一个全面的AI驱动开发工具包。
- 🚀 **CrewAI集成**:由协作AI代理驱动,支持复杂推理。
- 📡 **双重传输**:支持标准输入输出(stdio,适用于本地客户端)和服务器推送事件(SSE,适用于基于Web的客户端)。
- ✅ **模板合规性**:所有生成的文档遵循BMAD方法论模板。
- 🔍 **内置验证**:使用BMAD检查清单进行质量检查,确保高质量输出。
- 🐳 **Docker就绪**:通过Docker和Docker Compose轻松部署和扩展。
## 文档
有关详细的设置、配置、使用示例和开发工作流程,请参阅我们的完整[**文档**](./docs/index.md)。
## 快速开始(推荐使用Docker)
1. **克隆仓库:**
```bash
git clone https://github.com/bmad-project/bmad-mcp-server
cd bmad-mcp-server
```
2. **配置环境变量:**
复制示例环境文件并使用您的API密钥进行编辑:
```bash
cp .env.example .env
# 打开 .env 并添加您的LLM API密钥(OpenAI、Anthropic、Google Gemini、AWS Bedrock)
```
3. **使用Docker Compose运行:**
* 对于SSE模式(推荐用于大多数客户端):
```bash
docker-compose up bmad-mcp-server
```
服务器将在 `http://localhost:8000` 可用。
* 对于stdio模式:
```bash
docker-compose up bmad-mcp-stdio
```
有关不使用Docker的本地安装,请参见我们文档中的[入门指南](./docs/getting-started.md)。
## 可用工具(摘要)
### 项目规划工具
- **`create_project_brief`** - 生成结构化项目简报
- **`generate_prd`** - 创建包含史诗和故事的全面PRD
- **`validate_requirements`** - 检查PRD是否符合项目经理质量标准
### 架构工具
- **`create_architecture`** - 生成技术架构文档
- **`create_frontend_architecture`** - 设计前端特定架构
- **`validate_architecture`** - 检查架构是否符合质量标准(注意:此工具是概念性的,`run_checklist`与`architect_checklist.md`或`frontend_architecture_checklist.md`可以实现此目的)
### 故事管理工具
- **`create_next_story`** - 生成可开发的用户故事
- **`validate_story`** - 检查故事是否符合完成定义
### 质量工具
- **`run_checklist`** - 针对文档执行任何BMAD检查清单
- **`correct_course`** - 处理变更管理场景
## 文档
有关与各种AI助手(Cline、Claude Code、GitHub Copilot)和直接MCP客户端交互的详细使用示例,请参见我们的[开发工作流程](./docs/development-workflow.md)和[IDE集成](./docs/ide-integration.md)文档。
有关环境变量和服务器设置的详细配置选项,请参见[配置](./docs/configuration.md)文档。
## 贡献
1. Fork该仓库
2. 创建功能分支
3. 按照编码标准进行更改
4. 为新功能添加测试
5. 提交拉取请求
## 许可证
MIT许可证 - 详情请参见[LICENSE](LICENSE)。
## 相关项目
- [BMAD方法论](https://github.com/bmad-project/bmad-method) - 核心BMAD框架
- [CrewAI](https://github.com/crewAIInc/crewAI) - 多代理AI框架
- [模型上下文协议](https://modelcontextprotocol.io/) - AI工具集成标准