README
🚀 规范驱动开发MCP服务器
本项目是一个模型上下文协议(MCP)服务器,它通过提供结构化的提示,助力开发者遵循系统的方法,完成需求文档、设计文档的生成以及代码编写,实现规范驱动的开发工作流程。
🎯 目的
此MCP服务器通过提供引导性提示,让开发者能够遵循结构化的规范驱动开发方法,具体涵盖:
- 需求生成 - 使用EARS(简易需求语法方法)格式创建详细的需求文档。
- 设计生成 - 根据需求生成设计文档。
- 代码生成 - 根据设计文档生成实现代码。
✨ 主要特性
- 结构化工作流程:遵循从需求 → 设计 → 代码的清晰流程。
- 支持EARS格式:采用行业标准的EARS格式进行需求文档编写。
- MCP协议集成:可与支持MCP的工具和环境无缝集成。
🚀 快速开始
前提条件
- Node.js 20+
安装
VS Code
使用以下按钮在VS Code中安装MCP服务器:
或者,你可以在mcp.json中添加以下配置:
{
"servers": {
"spec-driven": {
"command": "npx",
"args": [
"-y",
"mcp-server-spec-driven-development@latest"
]
}
}
}
Cursor、Claude Code
使用以下按钮在Cursor中安装MCP服务器:
或者,你可以在mcp.json中添加以下配置:
{
"mcpServers": {
"spec-driven": {
"command": "npx",
"args": [
"-y",
"mcp-server-spec-driven-development@latest"
]
}
}
}
📋 可用提示
1. 生成需求文档
- 名称:
generate-requirements - 描述:使用EARS格式生成
requirements.md。 - 输入:应用程序的高级需求。例如:'一个具有任务创建、完成跟踪和本地存储持久化功能的Vue.js待办事项应用程序'。
- 输出:位于
specs/requirements.md的结构化需求文档。
2. 根据需求生成设计文档
- 名称:
generate-design-from-requirements - 描述:根据
requirements.md生成design.md。 - 输入:从
specs/requirements.md读取。 - 输出:位于
specs/design.md的设计文档。
3. 根据设计生成代码
- 名称:
generate-code-from-design - 描述:根据
design.md生成代码。 - 输入:从
specs/design.md读取。 - 输出:根文件夹中的实现代码。
📖 工作流示例
- 从需求开始:使用
generate-requirements提示,并输入初始需求文本。 - 创建设计:使用
generate-design-from-requirements根据需求创建设计文档。 - 生成代码:使用
generate-code-from-design根据设计生成实现代码。
这将创建一条从需求到设计再到实现的可追溯路径,确保开发过程的一致性和完整性。
🤔 为何选择规范驱动开发?
从凭感觉编码转向结构化、规范驱动的开发方法,能为开发工作流程带来清晰性、一致性和可维护性。规范驱动开发并非仅依靠直觉编码,而是为项目提供了一个可随复杂度提升而扩展的系统基础。
了解更多好处:再见,凭感觉编码!你好,规范驱动开发MCP服务器!
Scan to join WeChat group