🚀 規範工作流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許可證。