简介
Spec Workflow MCP 是一个基于Model Context Protocol (MCP)的开源服务器,专为规范驱动开发(Spec-Driven Development)工作流设计。该项目由Pimzino开发,为AI辅助软件开发提供了结构化的规范管理工具,包含实时Web仪表板和VSCode扩展,帮助团队从需求到实现的全程可视化管理和协作。
🔗 GitHub地址:
https://github.com/Pimzino/spec-workflow-mcp
🚀 核心价值:
规范驱动开发 · AI辅助 · 实时协作 · 多语言支持
技术特色:
-
MCP协议集成:标准化接口支持多种AI客户端
-
实时仪表板:Web和VSCode双界面实时监控
-
多语言支持:10种语言界面,全球团队适用
-
完整工作流:需求→设计→任务→实现的全程管理
-
审批系统:完整的文档审批和修订跟踪机制
主要功能
1. 核心架构

2. 功能矩阵
| 功能类别 | 核心能力 | 技术实现 |
|---|---|---|
| 规范创建 | 需求/设计/任务文档生成 | Markdown模板,AI辅助生成 |
| 进度跟踪 | 实时任务进度监控和可视化 | WebSocket实时更新,进度条 |
| 审批工作流 | 文档审批、反馈、修订跟踪 | JSON状态管理,版本控制 |
| 多语言支持 | 10种语言界面 | i18n国际化,动态语言切换 |
| 归档系统 | 完成规范归档管理 | 文件系统组织,元数据管理 |
| 模板系统 | 预建文档模板 | Markdown模板库,自定义模板 |
3. 技术特性
-
跨平台支持:Windows、macOS、Linux全兼容
-
实时协作:WebSocket实现多用户实时更新
-
声音通知:可配置的审批和完成提醒
-
黑暗模式:自动适应的界面主题
-
扩展架构:插件化和模块化设计
安装与配置
1. 环境要求
# 基础要求
Node.js: 18.0+
npm: 8.0+
操作系统: Windows/macOS/Linux
内存: 2GB+ RAM
存储: 500MB+ 可用空间
# 推荐配置
Node.js: 20.0+
内存: 4GB+ RAM
网络: 稳定互联网连接
2. 快速安装
通过npx直接运行:
# 基础安装
npx -y @pimzino/spec-workflow-mcp@latest /path/to/your/project
# 自动启动仪表板
npx -y @pimzino/spec-workflow-mcp@latest /path/to/your/project --AutoStartDashboard
# 自定义端口
npx -y @pimzino/spec-workflow-mcp@latest /path/to/your/project --AutoStartDashboard --port 3456
VSCode扩展安装:
-
在VSCode中搜索"Spec Workflow MCP"
-
安装扩展
-
在包含
.spec-workflow/目录的项目中打开VSCode -
通过Activity Bar图标访问功能
3. 配置管理
配置文件示例 (config.toml):
# 项目配置
projectDir = "/path/to/your/project"
port = 3456
autoStartDashboard = true
dashboardOnly = false
lang = "zh" # 中文界面
# MCP服务器设置
[mcp]
enabled = true
host = "localhost"
port = 8080
# 通知设置
[notifications]
sound_enabled = true
approval_sound = "chime"
completion_sound = "success"
环境变量配置:
# 设置环境变量
export SPEC_PROJECT_DIR="/path/to/your/project"
export SPEC_PORT="3000"
export SPEC_LANG="zh"
export SPEC_AUTO_START="true"
4. 客户端配置
Claude Desktop配置:
{
"mcpServers": {
"spec-workflow": {
"command": "npx",
"args": [
"-y",
"@pimzino/spec-workflow-mcp@latest",
"/path/to/your/project",
"--AutoStartDashboard"
]
}
}
}
Cursor IDE配置:
{
"mcpServers": {
"spec-workflow": {
"command": "npx",
"args": [
"-y",
"@pimzino/spec-workflow-mcp@latest",
"/path/to/your/project"
]
}
}
}
使用指南
1. 基础工作流

2. 核心操作示例
创建规范文档:
# 通过AI对话创建规范
@spec-workflow 创建用户认证功能的规范
# 或使用具体命令
@spec-workflow create-spec-doc --name "user-auth" --type "requirements"
查看项目状态:
# 列出所有规范
@spec-workflow spec-list
# 查看具体规范状态
@spec-workflow spec-status --name "user-auth"
# 获取详细上下文
@spec-workflow get-spec-context --name "user-auth"
任务管理:
# 管理任务
@spec-workflow manage-tasks --spec "user-auth" --action "list"
# 执行具体任务
@spec-workflow 执行用户认证规范的任务1.2
3. 审批工作流
# 审批请求示例
approval_request = {
"document_type": "requirements",
"document_name": "user-auth",
"approvers": ["project-lead", "tech-lead"],
"deadline": "2024-12-20",
"priority": "high"
}
# 检查审批状态
@spec-workflow get-approval-status --doc-id "user-auth-req-001"
# 审批操作
@spec-workflow request-approval --doc-id "user-auth-req-001"
4. 模板使用
# 使用模板创建文档
@spec-workflow get-template-context --type "requirements"
# 生成的模板示例
## 需求规范模板
### 功能描述
{功能详细描述}
### 用户故事
- 作为[角色],我想要[功能],以便[价值]
### 验收标准
- [ ] 标准1
- [ ] 标准2
### 技术考虑
- 技术约束和依赖
应用场景实例
案例1:敏捷团队规范管理
场景:跨地域敏捷团队需要统一规范流程
解决方案:

技术实现:
# 多团队配置
[teams]
team1 = { name = "前端团队", lang = "zh", timezone = "Asia/Shanghai" }
team2 = { name = "后端团队", lang = "en", timezone = "UTC" }
team3 = { name = "QA团队", lang = "ja", timezone = "Asia/Tokyo" }
[approval]
workflow = "multi-level"
levels = [
{ role = "tech-lead", required = true },
{ role = "product-owner", required = true },
{ role = "qa-lead", required = false }
]
实施效果:
-
规范一致性 提升80%
-
评审效率 提高60%
-
跨团队协作 障碍减少70%
-
项目可视化 达到100%覆盖
案例2:企业级合规开发
场景:金融行业合规软件开发
解决方案:
# 合规开发工作流
class ComplianceWorkflow:
def __init__(self, project_path):
self.project_path = project_path
self.compliance_rules = self.load_compliance_rules()
def create_compliant_spec(self, feature_name, regulation):
# 生成符合规范的文档
spec = self.generate_spec(feature_name)
spec = self.apply_compliance(spec, regulation)
spec = self.add_audit_trail(spec)
return spec
def approval_workflow(self, document):
# 多层级审批
approvals = [
self.request_approval(document, "compliance-officer"),
self.request_approval(document, "security-team"),
self.request_approval(document, "legal-team")
]
return all(approvals)
# 使用示例
workflow = ComplianceWorkflow("/projects/finance-app")
spec = workflow.create_compliant_spec("transaction-processing", "PCI-DSS")
approved = workflow.approval_workflow(spec)
实施效果:
-
合规符合率 100%
-
审计追踪 完整记录
-
审批流程 从2周缩短至2天
-
合规成本 降低50%
案例3:教育机构项目管理
场景:大学软件工程课程团队项目管理
解决方案:
# 教育版配置
education:
enabled: true
features:
team_management: true
progress_grading: true
peer_review: true
template_library: true
templates:
academic:
- name: "课程项目需求模板"
file: "templates/academic/requirements.md"
- name: "毕业设计规范模板"
file: "templates/academic/thesis.md"
- name: "团队协作指南"
file: "templates/academic/teamwork.md"
grading:
criteria:
- name: "规范完整性"
weight: 0.3
- name: "进度管理"
weight: 0.2
- name: "团队协作"
weight: 0.2
- name: "文档质量"
weight: 0.3
实施效果:
-
学生项目质量 提升40%
-
教师评审效率 提高70%
-
团队协作能力 显著增强
-
项目管理技能 实践掌握
案例4:开源项目协作
场景:大型开源项目贡献者管理
解决方案:
# 开源项目工作流配置
npx @pimzino/spec-workflow-mcp@latest /open-source/project \
--config opensource.toml \
--port 3000 \
--AutoStartDashboard
# opensource.toml
[open_source]
community_managed = true
contribution_guidelines = "CONTRIBUTING.md"
code_of_conduct = "CODE_OF_CONDUCT.md"
license = "MIT"
[approval]
workflow = "community"
maintainers = ["maintainer1", "maintainer2", "maintainer3"]
required_approvals = 2
auto_merge = true
[notifications]
pr_notifications = true
issue_tracking = true
community_updates = true
实施效果:
-
贡献者参与度 提升60%
-
PR处理速度 加快50%
-
代码质量 显著提高
-
社区活跃度 持续增长
高级功能与定制
1. 自定义模板开发
# 自定义模板示例
## ${spec_name} 需求规范
### 业务目标
${business_goals}
### 功能需求
{{#each features}}
- ${this.description}
- 优先级: ${this.priority}
- 复杂度: ${this.complexity}
{{/each}}
### 非功能需求
- 性能: ${performance_requirements}
- 安全: ${security_requirements}
- 可用性: ${usability_requirements}
### 验收标准
{{#each acceptance_criteria}}
- [ ] ${this.description}
{{/each}}
2. Webhook集成
# 外部系统集成
webhooks:
- name: "ci-cd-integration"
url: "https://ci.example.com/webhook"
events: ["spec_approved", "task_completed"]
secret: "${WEBHOOK_SECRET}"
- name: "slack-notifications"
url: "https://hooks.slack.com/services/..."
events: ["approval_requested", "comment_added"]
channel: "#project-updates"
- name: "jira-sync"
url: "https://jira.example.com/rest/api/2/issue"
events: ["spec_created", "task_updated"]
auth: "basic"
3. 高级审批工作流
# 多条件审批规则
approval_rules:
- name: "高风险功能审批"
conditions:
- field: "risk_level"
operator: "equals"
value: "high"
approvers: ["cto", "security-head", "compliance-officer"]
required_approvals: 3
timeout: "48h"
- name: "常规功能审批"
conditions:
- field: "risk_level"
operator: "equals"
value: "medium"
approvers: ["tech-lead", "product-owner"]
required_approvals: 2
timeout: "24h"
- name: "低风险功能审批"
conditions:
- field: "risk_level"
operator: "equals"
value: "low"
approvers: ["senior-developer"]
required_approvals: 1
timeout: "12h"
🌟 GitHub地址:
https://github.com/Pimzino/spec-workflow-mcp
📚 详细文档:
项目README和docs目录
🎮 演示体验:
通过npx快速体验
Spec Workflow MCP 代表了规范驱动开发的未来方向。正如开发者所述:
"我们通过MCP协议将AI辅助开发与结构化工作流完美结合,让规范驱动开发变得简单而高效"
该工具已在多个领域证明其价值:
-
企业开发:合规性管理和审计追踪
-
教育机构:项目管理和学习评估
-
开源社区:贡献者协作和质量管理
-
敏捷团队:跨地域协作和进度跟踪
-
个人项目:规范化开发和进度控制
立即体验Spec Workflow MCP,开启规范驱动开发新纪元!