🚀 规范工作流MCP
通过结构化的 需求 → 设计 → 任务 工作流引导人工智能系统地完成软件开发,确保代码实现与业务需求保持一致。
徽章与语言选择

English | 简体中文
✨ 主要特性
❌ 无规范工作流的情况
- 人工智能在任务间随机跳跃,缺乏系统方法。
- 需求与实际代码实现脱节。
- 文档分散,难以跟踪项目进度。
- 缺少设计决策记录。
✅ 有规范工作流的情况
- 人工智能按顺序完成任务,保持专注和上下文连贯性。
- 从用户故事到代码实现具有完整的可追溯性。
- 标准化的文档模板,具备自动进度管理功能。
- 每个阶段都需要确认,确保项目方向正确。
- 持久进度:使用
check
命令可从上次中断处继续,即使在新对话中也能如此。
🆕 近期更新
v1.0.6
- ✨ 批量任务完成:可一次性完成多个任务,加快大型项目的进度。
v1.0.5
- 🐛 边缘情况修复:区分“任务未找到”和“任务已完成”,防止工作流中断。
v1.0.4
- ✅ 任务管理:增加了任务完成跟踪功能,实现项目的系统推进。
v1.0.3
- 🎉 初始版本发布:具备从需求到设计再到任务的核心工作流框架。
🚀 快速开始
1. 安装(Claude代码示例)
claude mcp add spec-workflow-mcp -s user -- npx -y spec-workflow-mcp@latest
其他客户端的完整安装指南请见 安装说明。
2. 启动新项目
"Help me use spec workflow to create a user authentication system"
3. 继续现有项目
"Use spec workflow to check ./my-project"
人工智能将自动检测项目状态,并从上次中断处继续。
💻 使用示例
基础用法
1. 描述需求
You: "I need to build a user authentication system"
2. 人工智能创建结构化文档
AI: "I'll help you create spec workflow for user authentication..."
📝 requirements.md - 用户故事和功能需求
🎨 design.md - 技术架构和设计决策
✅ tasks.md - 具体实现任务列表
3. 逐步审查和实施
每个阶段完成后,人工智能会请求您的确认,然后再继续,确保项目方向正确。
📚 详细文档
文档组织结构
基本结构
my-project/specs/
├── requirements.md # 需求:用户故事、功能规格
├── design.md # 设计:架构、API、数据模型
├── tasks.md # 任务:编号的实现步骤
└── .workflow-confirmations.json # 状态:自动进度跟踪
多模块项目
my-project/specs/
├── user-authentication/ # 认证模块
├── payment-system/ # 支付模块
└── notification-service/ # 通知模块
您可以指定任何目录:"Use spec workflow to create auth docs in ./src/features/auth"
人工智能使用指南
🤖 让人工智能更好地使用此工具
强烈建议 在您的人工智能助手配置中添加以下提示。如果不添加,人工智能可能会:
- ❌ 不知道何时调用规范工作流。
- ❌ 忘记管理任务进度,导致工作混乱。
- ❌ 不利用规范工作流进行系统的文档编写。
- ❌ 无法持续跟踪项目状态。
添加此配置后,人工智能将智能地使用规范工作流来管理整个开发过程。
配置说明:请根据您的需求修改以下内容:
- 将
./specs
更改为您首选的文档目录路径。
- 将 "English" 更改为您首选的文档语言(例如,"Chinese")。
# 规范工作流使用指南
## 1. 检查项目进度
当用户提及继续之前的项目或不确定当前进度时,主动使用:
specs-workflow 工具,action.type="check" 且 path="./specs"
## 2. 文档语言
所有规范工作流文档应始终使用英语编写,包括需求、设计和任务文档中的所有内容。
## 3. 文档目录
所有规范工作流文档应放置在 ./specs 目录中,以保持项目文档组织的一致性。
## 4. 任务管理
始终使用以下方式管理任务进度:
specs-workflow 工具,action.type="complete_task" 且 taskNumber="当前任务编号"
遵循工作流指导继续工作,直到所有任务完成。
## 5. 最佳实践
- 主动检查进度:当用户说 "continue from last time" 时,首先使用 check 查看当前状态。
- 语言一致性:在所有项目文档中使用相同的语言。
- 灵活的结构:根据项目规模选择单模块或多模块组织方式。
- 任务粒度:每个任务应能在1 - 2小时内完成。
📦 安装
📦 安装说明
要求
- Node.js ≥ v18.0.0
- npm 或 yarn
- Claude Desktop 或任何兼容MCP的客户端
在不同MCP客户端中安装
Claude Code(推荐)
使用Claude CLI添加MCP服务器:
claude mcp add spec-workflow-mcp -s user -- npx -y spec-workflow-mcp@latest
Claude Desktop
添加到您的Claude Desktop配置中:
- macOS:
~/Library/Application Support/Claude/claude_desktop_config.json
- Windows:
%APPDATA%/Claude/claude_desktop_config.json
- Linux:
~/.config/Claude/claude_desktop_config.json
{
"mcpServers": {
"spec-workflow": {
"command": "npx",
"args": ["-y", "spec-workflow-mcp@latest"]
}
}
}
Cursor
添加到您的Cursor配置(~/.cursor/config.json
)中:
{
"mcpServers": {
"spec-workflow": {
"command": "npx",
"args": ["-y", "spec-workflow-mcp@latest"]
}
}
}
Cline
使用Cline的MCP服务器管理UI添加服务器:
- 打开安装了Cline扩展的VS Code。
- 打开Cline设置(齿轮图标)。
- 导航到MCP Servers部分。
- 添加新服务器,设置如下:
- 命令:
npx
- 参数:
-y spec-workflow-mcp@latest
Windsurf (Codeium)
添加到您的Windsurf配置(~/.codeium/windsurf/mcp_config.json
)中:
{
"mcpServers": {
"spec-workflow": {
"command": "npx",
"args": ["-y", "spec-workflow-mcp@latest"],
"env": {},
"autoApprove": [],
"disabled": false,
"timeout": 60,
"transportType": "stdio"
}
}
}
VS Code(带有MCP扩展)
添加到您的VS Code设置(settings.json
)中:
{
"mcp.servers": {
"spec-workflow": {
"command": "npx",
"args": ["-y", "spec-workflow-mcp@latest"]
}
}
}
Zed
添加到您的Zed配置(~/.config/zed/settings.json
)中:
{
"assistant": {
"version": "2",
"mcp": {
"servers": {
"spec-workflow": {
"command": "npx",
"args": ["-y", "spec-workflow-mcp@latest"]
}
}
}
}
}
从源代码安装
git clone https://github.com/kingkongshot/specs-mcp.git
cd specs-mcp
npm install
npm run build
然后添加到Claude Desktop配置中:
{
"mcpServers": {
"spec-workflow": {
"command": "node",
"args": ["/absolute/path/to/specs-mcp/dist/index.js"]
}
}
}
🔗 链接
📄 许可证
本项目采用MIT许可证。