规格工作流服务器
项目介绍
Spec Workflow MCP
这是一个用于结构化规范驱动开发的 Model Context Protocol (MCP) 服务器，带有实时仪表板和 VSCode 扩展。
☕ 支持此项目
<a href="https://buymeacoffee.com/Pimzino" target="_blank"><img src="https://gips2.baidu.com/it/u=2811292181,1350118012&fm=3081&app=3081&f=PNG?w=545&h=153" alt="买我一杯咖啡" style="height: 60px !important;width: 217px !important;" ></a>
📺 展示
🔄 审批系统演示
<a href="https://www.youtube.com/watch?v=C-uEa3mfxd0" target="_blank"> <img src="https://img.youtube.com/vi/C-uEa3mfxd0/maxresdefault.jpg" alt="审批系统演示" width="600"> </a>了解审批系统的工作方式：创建文档、通过仪表板请求审批、提供反馈并跟踪修订。
📊 仪表板与规范管理
<a href="https://www.youtube.com/watch?v=g9qfvjLUWf8" target="_blank"> <img src="https://img.youtube.com/vi/g9qfvjLUWf8/maxresdefault.jpg" alt="仪表板演示" width="600"> </a>探索实时仪表板：查看规范、跟踪进度、导航文档并监控您的开发流程。
✨ 主要功能
- 结构化开发工作流 - 顺序规范创建（需求 → 设计 → 任务）
- 实时网络仪表板 - 监控规范、任务和进度，实时更新
- VSCode 扩展 - 集成到 VSCode 的侧边栏仪表板
- 审批工作流 - 完整的审批过程，包括修订
- 任务进度跟踪 - 可视化进度条和详细状态
- 实施日志 - 搜索所有任务实施的日志，包含代码统计信息
- 多语言支持 - 提供 11 种语言版本
🌍 支持的语言
🇺🇸 英语 • 🇯🇵 日语 • 🇨🇳 中文 • 🇪🇸 西班牙语 • 🇧🇷 葡萄牙语 • 🇩🇪 德语 • 🇫🇷 法语 • 🇷🇺 俄语 • 🇮🇹 意大利语 • 🇰🇷 韩语 • 🇸🇦 阿拉伯语
🚀 快速开始
第一步：添加到您的AI工具
在您的 MCP 配置中添加（参见客户端特定设置）：
{
"mcpServers": {
"spec-workflow": {
"command": "npx",
"args": ["-y", "@pimzino/spec-workflow-mcp@latest", "/path/to/your/project"]
}
}
}
第二步：选择您的界面
选项 A：Web 仪表板 （适用于 CLI 用户） 启动仪表板（默认运行在端口 5000）：
npx -y @pimzino/spec-workflow-mcp@latest --dashboard
仪表板将在 http://localhost:5000 可用。
注意： 只需要一个仪表板实例。所有项目都将连接到同一个仪表板。
选项 B：VSCode 扩展 （推荐给 VSCode 用户）
从 VSCode 市场安装 Spec Workflow MCP 扩展。
📝 如何使用
只需在对话中提及 spec-workflow：
- "创建用户认证规范" - 创建完整的规范工作流
- "列出我的规范" - 显示所有规范及其状态
- "执行用户认证规范中的任务 1.2" - 运行特定任务
🔧 MCP 客户端设置
<details> <summary><strong>Augment 代码</strong></summary>在您的 Augment 设置中配置：
{
"mcpServers": {
"spec-workflow": {
"command": "npx",
"args": ["-y", "@pimzino/spec-workflow-mcp@latest", "/path/to/your/project"]
}
}
}
添加到您的 MCP 配置：
claude mcp add spec-workflow npx @pimzino/spec-workflow-mcp@latest -- /path/to/your/project
重要提示：
-y标志绕过 npm 提示，使安装更顺畅--分隔符确保路径传递给 spec-workflow 脚本，而不是 npx- 将
/path/to/your/project替换为您实际的项目目录路径
Windows 系统的替代方法（如果上述方法不起作用）：
claude mcp add spec-workflow cmd.exe /c "npx @pimzino/spec-workflow-mcp@latest /path/to/your/project"
添加到 claude_desktop_config.json：
{
"mcpServers": {
"spec-workflow": {
"command": "npx",
"args": ["-y", "@pimzino/spec-workflow-mcp@latest", "/path/to/your/project"]
}
}
}
</details> <details> <summary><strong>Cline/Claude Dev</strong></summary>重要： 在启动 MCP 服务器之前，请单独运行带有
--dashboard的仪表板。
添加到您的 MCP 服务器配置：
{
"mcpServers": {
"spec-workflow": {
"command": "npx",
"args": ["-y", "@pimzino/spec-workflow-mcp@latest", "/path/to/your/project"]
}
}
}
添加到您的 Continue 配置：
{
"mcpServers": {
"spec-workflow": {
"command": "npx",
"args": ["-y", "@pimzino/spec-workflow-mcp@latest", "/path/to/your/project"]
}
}
}
添加到您的 Cursor 设置（settings.json）：
{
"mcpServers": {
"spec-workflow": {
"command": "npx",
"args": ["-y", "@pimzino/spec-workflow-mcp@latest", "/path/to/your/project"]
}
}
}
添加到您的 opencode.json 配置文件：
{
"$schema": "https://opencode.ai/config.json",
"mcp": {
"spec-workflow": {
"type": "local",
"command": ["npx", "-y", "@pimzino/spec-workflow-mcp@latest", "/path/to/your/project"],
"enabled": true
}
}
}
🐳 Docker 部署
在 Docker 容器中运行仪表板以实现隔离部署：
# 使用 Docker Compose（推荐）
cd containers
docker-compose up --build
# 或者使用 Docker CLI
docker build -f containers/Dockerfile -t spec-workflow-mcp .
docker run -p 5000:5000 -v "./workspace/.spec-workflow:/workspace/.spec-workflow:rw" spec-workflow-mcp
仪表板将在 http://localhost:5000 可用。
📚 文档
- 配置指南 - 命令行选项，配置文件
- 用户指南 - 综合使用示例
- 工作流程过程 - 开发工作流和最佳实践
- 接口指南 - 仪表板和 VSCode 扩展详情
- 提示指南 - 高级提示示例
- 工具参考 - 完整工具文档
- 开发 - 贡献和开发设置
- 故障排除 - 常见问题及解决方案
📁 项目结构
your-project/
.spec-workflow/
approvals/
archive/
specs/
steering/
templates/
user-templates/
config.example.toml
🛠️ 开发
# 安装依赖
npm install
# 构建项目
npm run build
# 在开发模式下运行
npm run dev
📄 许可证
GPL-3.0