规范工作流管理工具

通过结构化的需求→设计→任务工作流指导AI系统完成软件开发,确保代码实现与业务需求保持一致。

  • by kingkongshot
  • TypeScript
  • 本地部署
  • 127 星标
  • 更新于
在 GitHub 查看 kingkongshot/specs-workflow-mcp

使用说明

规范工作流程MCP

英语 | 简体中文

引导AI通过结构化的方法系统地完成软件开发 需求→ 设计→ Tasks 工作流,确保代码实现与业务需求保持一致。

为什么要使用它?

❌ 无规范工作流

  • AI在任务之间随机跳跃,缺乏系统方法
  • 需求与实际代码实现脱节
  • 文件零散,难以跟踪项目进度
  • 缺少设计决策记录

✅ 使用规范工作流

  • AI按顺序完成任务,保持专注和上下文
  • 从用户故事到代码实现的完全可追溯性
  • 具有自动进度管理的标准化文档模板
  • 每个阶段都需要确认,确保方向正确
  • 持续进步:从你停止的地方继续 check,即使在新的对话中

最近的更新

v1.0.7

  • 🎯 提高了大多数模型使用规范工作流管理任务的可靠性

v1.0.6

  • ✨ 批量任务完成:一次完成多个任务,以加快大型项目的进度

v1.0.5

  • 🐛 边缘案例修复:区分“任务未找到”和“任务已完成”,以防止工作流中断

v1.0.4

  • ✅ 任务管理:增加了任务完成跟踪,用于系统项目进度

v1.0.3

  • 🎉 初始版本:需求的核心工作流框架→ 设计→ Tasks

快速开始

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"

AI将自动检测项目状态,并从停止的地方继续。

工作流示例

1.您描述了要求

You: "I need to build a user authentication system"

2.人工智能创建结构化文档

AI: "I'll help you create spec workflow for user authentication..."

📝 requirements.md - User stories and functional requirements
🎨 design.md - Technical architecture and design decisions
✅ tasks.md - Concrete implementation task list

3.审查并逐步实施

在每个阶段之后,AI都会在继续之前请求您的确认,以确保项目保持在正确的轨道上。

文档组织

基本结构

my-project/specs/
├── requirements.md              # Requirements: user stories, functional specs
├── design.md                    # Design: architecture, APIs, data models
├── tasks.md                     # Tasks: numbered implementation steps
└── .workflow-confirmations.json # Status: automatic progress tracking

多模块项目

my-project/specs/
├── user-authentication/         # Auth module
├── payment-system/             # Payment module
└── notification-service/       # Notification module

您可以指定任何目录: "Use spec workflow to create auth docs in ./src/features/auth"

AI使用指南

🤖 让AI更好地使用这个工具

强烈推荐 将以下提示添加到您的AI助手配置中。没有它,AI可能会:

  • ❌ 不知道何时调用规范工作流
  • ❌ 忘记管理任务进度,导致工作混乱
  • ❌ 不使用规范工作流程进行系统文档编制
  • ❌ 无法持续跟踪项目状态

通过这种配置,AI将智能地使用Spec Workflow来管理整个开发过程。

配置说明:请根据您的需要修改以下内容:

  1. 改变 ./specs 到您首选的文档目录路径
  2. 将“英语”更改为您首选的文档语言(例如“中文”)
# Spec Workflow Usage Guidelines

## 1. Check Project Progress
When user mentions continuing previous project or is unsure about current progress, proactively use:
specs-workflow tool with action.type="check" and path="./specs"

## 2. Documentation Language
All spec workflow documents should be written in English consistently, including all content in requirements, design, and task documents.

## 3. Documentation Directory
All spec workflow documents should be placed in ./specs directory to maintain consistent project documentation organization.

## 4. Task Management
Always use the following to manage task progress:
specs-workflow tool with action.type="complete_task" and taskNumber="current task number"
Follow the workflow guidance to continue working until all tasks are completed.

## 5. Best Practices
- Proactive progress check: When user says "continue from last time", first use check to see current status
- Language consistency: Use the same language throughout all project documents
- Flexible structure: Choose single-module or multi-module organization based on project scale
- Task granularity: Each task should be completable within 1-2 hours

安装

📦 Installation Instructions

需求

  • Node.js≥v18.0.0
  • npm或纱线
  • Claude Desktop或任何兼容MCP的客户端

在不同的MCP客户端中安装

克劳德代码(推荐)

使用Claude CLI添加MCP服务器:

claude mcp add spec-workflow-mcp -s user -- npx -y spec-workflow-mcp@latest

克劳德桌面

添加到您的Claude Desktop配置中:

  • macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
  • 窗户: %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/config.json):

{
  "mcpServers": {
    "spec-workflow": {
      "command": "npx",
      "args": ["-y", "spec-workflow-mcp@latest"]
    }
  }
}

克莱恩

使用Cline的MCP服务器管理UI添加服务器:

  1. 使用Cline扩展名打开VS代码
  2. 打开Cline设置(齿轮图标)
  3. 导航到MCP服务器部分
  4. 使用以下命令添加新服务器:
    • 命令: npx
    • 论据: -y spec-workflow-mcp@latest

风帆冲浪(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代码(带MCP扩展名)

添加到您的VS代码设置(settings.json):

{
  "mcp.servers": {
    "spec-workflow": {
      "command": "npx",
      "args": ["-y", "spec-workflow-mcp@latest"]
    }
  }
}

泽德

添加到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许可证