mcp-openspec-server
v1.0.0
Published
MCP server for OpenSpec requirement analysis and AI-driven development workflow
Maintainers
Readme
OpenSpec MCP Server - AI 驱动的自动化开发工作流
MCP 服务器,配合 Amazon Q 实现从需求到代码的自动化开发工作流。
核心功能
📋 需求分析
- analyze_requirement - 分析需求文档,提取需求列表
- breakdown_requirement - 拆解需求为具体开发任务
- generate_dev_plan - 生成完整的开发计划
🎯 设计生成
- generate_api_design - 生成 RESTful API 接口设计
- generate_db_design - 生成数据库表结构设计
- generate_page_structure - 生成前端页面结构设计
🧪 质量保障
- generate_test_cases - 生成测试用例
- generate_review_checklist - 生成代码审查清单
🤖 AI 协作
- generate_amazonq_prompts - 为每个任务生成 Amazon Q 提示词
安装
方式 1:本地使用(推荐)
cd mcp-openspec-server
npm install方式 2:npm 安装(如果已发布)
npm install -g mcp-openspec-server方式 3:npx 使用(无需安装)
npx mcp-openspec-server配置 Claude Desktop
编辑 Claude Desktop 配置文件:
Windows: %APPDATA%\Claude\claude_desktop_config.json
macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
本地使用配置
{
"mcpServers": {
"openspec": {
"command": "node",
"args": ["d:\\km-overseas-web\\mcp-openspec-server\\server.js"]
}
}
}npm 全局安装配置
{
"mcpServers": {
"openspec": {
"command": "mcp-openspec"
}
}
}npx 使用配置
{
"mcpServers": {
"openspec": {
"command": "npx",
"args": ["-y", "mcp-openspec-server"]
}
}
}重启 Claude Desktop 即可使用。
快速开始
cd mcp-openspec-server
npm install配置 Claude Desktop 后,在对话中输入:
我有一个需求文档,请帮我:
1. 分析需求
2. 生成开发计划
3. 生成技术设计
4. 生成 Amazon Q 提示词
需求文档:
# 产品大类管理
- 产品大类列表页面,支持查询、新增、编辑、删除
- 产品大类详情页面,展示大类信息完整工作流示例
第一步:需求分析(在 Claude Desktop 中)
请使用 analyze_requirement 工具分析以下需求:
# 产品大类管理
- 产品大类列表页面,支持查询、新增、编辑、删除
- 产品大类详情页面,展示大类信息
- 支持按所属产业筛选第二步:生成开发计划
请使用 generate_dev_plan 工具生成开发计划第三步:生成技术设计
请依次使用以下工具:
1. generate_db_design - 生成数据库设计
2. generate_api_design - 生成 API 设计
3. generate_page_structure - 生成页面结构第四步:生成 Amazon Q 提示词
请使用 generate_amazonq_prompts 工具生成 Amazon Q 提示词第五步:在 VSCode 中使用 Amazon Q 开发
复制生成的提示词,在 VSCode 的 Amazon Q 中执行:
// 数据库设计提示词
请根据以下需求设计数据库表结构:
模块:产品大类管理
需求:产品大类列表页面,支持查询、新增、编辑、删除
要求:
1. 使用项目规范的字段命名
2. 包含基础字段(id, create_time, update_time等)
3. 添加详细的字段注释
// API 开发提示词
请开发以下API接口:
模块:产品大类管理
需求:产品大类列表页面,支持查询、新增、编辑、删除
要求:
1. 遵循项目API规范
2. 在 src/api/product/ 目录下创建
3. 包含 productApi.js 和 index.js
4. 添加详细注释
// 页面开发提示词
请创建以下页面:
模块:产品大类管理
需求:产品大类列表页面,支持查询、新增、编辑、删除
要求:
1. 使用 FilterCompts 组件实现筛选
2. 使用 el-table 展示列表
3. 使用 PageControl 分页
4. 遵循 UI 开发规范
5. 添加详细注释第六步:代码审查
请使用 generate_review_checklist 工具生成审查清单然后在 VSCode 中使用 Amazon Q 的 /review 命令审查代码。
第七步:生成测试用例
请使用 generate_test_cases 工具生成测试用例然后在 VSCode 中使用 Amazon Q 的 /test 命令生成测试代码
工具详细说明
📋 需求分析工具
analyze_requirement
- 提取需求列表
- 识别功能模块
- 判断优先级(高/中)
breakdown_requirement
- 拆解为具体任务:数据库设计、API开发、前端页面、前端组件
- 为每个任务分配 ID
- 关联模块和优先级
generate_dev_plan
- 生成分阶段开发计划
- 阶段:数据库设计 → API开发 → 前端开发 → 测试与优化
- 统计任务数量和优先级分布
🎯 设计生成工具
generate_api_design
- 生成 RESTful API 接口
- 自动识别 CRUD 操作
- 遵循项目 API 规范
generate_db_design
- 生成数据库表结构
- 包含基础字段(id, create_time, update_time 等)
- 按模块分组
generate_page_structure
- 生成页面路由配置
- 推荐使用的组件(FilterCompts, el-table, PageControl 等)
- 列出页面功能点
🧪 质量保障工具
generate_test_cases
- 生成测试用例编号(TC001, TC002...)
- 包含测试步骤和预期结果
- 按优先级分类
generate_review_checklist
- 代码规范检查项
- API 规范检查项
- UI 规范检查项
🤖 AI 协作工具
generate_amazonq_prompts
- 为每个任务生成专门的 Amazon Q 提示词
- 包含:数据库设计、API开发、页面开发、组件开发
- 提示词已包含项目规范要求
支持的需求格式
# 模块名称
- 需求1
- 需求2
## 子模块
1. 需求3
2. 需求4
【功能模块】
* 需求5自动化工作流优势
🚀 效率提升
- 需求分析自动化:秒级完成需求拆解
- 设计生成自动化:自动生成 API、数据库、页面设计
- 提示词生成:为 Amazon Q 生成精准的开发指令
- 质量保障:自动生成测试用例和审查清单
🎯 质量保证
- 规范一致性:所有生成内容遵循项目规范
- 完整性检查:确保 API、数据库、页面设计完整
- 可追溯性:每个任务都有明确的需求来源
🤝 AI 协作
- Claude Desktop:需求分析、设计生成、计划制定
- Amazon Q:代码实现、测试生成、代码审查
- 无缝衔接:生成的提示词直接用于 Amazon Q
典型使用场景
场景1:新功能开发
- Claude Desktop 分析需求 → 生成开发计划
- Claude Desktop 生成技术设计 → 生成 Amazon Q 提示词
- VSCode 中使用 Amazon Q 实现代码
- Amazon Q
/review审查代码 - Amazon Q
/test生成测试
场景2:需求评审
- 使用
analyze_requirement提取需求列表 - 使用
breakdown_requirement评估工作量 - 使用
generate_dev_plan制定排期
场景3:技术方案设计
- 使用
generate_db_design设计数据库 - 使用
generate_api_design设计接口 - 使用
generate_page_structure设计页面 - 输出完整技术方案文档
场景4:代码审查准备
- 使用
generate_review_checklist生成检查清单 - 在 VSCode 中使用 Amazon Q
/review审查 - 对照清单逐项检查
最佳实践
- 需求文档规范化:使用 Markdown 格式,清晰的模块划分
- 分步执行:先分析需求 → 再生成设计 → 最后生成代码
- 提示词优化:根据实际情况调整生成的 Amazon Q 提示词
- 代码审查:使用生成的检查清单进行全面审查
- 测试覆盖:使用生成的测试用例确保质量
