# spec-workflow-mcp

**Repository Path**: crazymonkey186/spec-workflow-mcp

## Basic Information

- **Project Name**: spec-workflow-mcp
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: GPL-3.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-09-20
- **Last Updated**: 2025-09-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Spec Workflow MCP

[![npm version](https://img.shields.io/npm/v/@pimzino/spec-workflow-mcp)](https://www.npmjs.com/package/@pimzino/spec-workflow-mcp)
[![VSCode Extension](https://badgen.net/vs-marketplace/v/Pimzino.spec-workflow-mcp)](https://marketplace.visualstudio.com/items?itemName=Pimzino.spec-workflow-mcp)

一个用于结构化规范驱动开发的模型上下文协议（MCP）服务器，配有实时仪表板和VSCode扩展。

## ☕ 支持这个项目

<a href="https://buymeacoffee.com/Pimzino" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" 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="Approval System Demo" 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="Dashboard Demo" width="600">
</a>

*探索实时仪表板：查看规范，跟踪进度，浏览文档，并监控您的开发工作流程。*

## ✨ 主要功能

- **结构化开发工作流程** - 顺序创建规范（需求 → 设计 → 任务）
- **实时Web仪表板** - 实时更新监控规范、任务和进度
- **VSCode扩展** - 为VSCode用户集成侧边栏仪表板
- **审批工作流程** - 完整的审批流程，支持修订
- **任务进度跟踪** - 可视化进度条和详细状态
- **多语言支持** - 支持11种语言

## 🌍 支持的语言

🇺🇸 English • 🇯🇵 日本語 • 🇨🇳 中文 • 🇪🇸 Español • 🇧🇷 Português • 🇩🇪 Deutsch • 🇫🇷 Français • 🇷🇺 Русский • 🇮🇹 Italiano • 🇰🇷 한국어 • 🇸🇦 العربية

## 🚀 快速开始

### 第1步：添加到您的AI工具

添加到您的MCP配置中（请参见下面特定客户端的设置）：

```json
{
  "mcpServers": {
    "spec-workflow": {
      "command": "npx",
      "args": ["-y", "@pimzino/spec-workflow-mcp@latest", "/path/to/your/project"]
    }
  }
}
```

自动启动仪表板：
```json
{
  "mcpServers": {
    "spec-workflow": {
      "command": "npx",
      "args": ["-y", "@pimzino/spec-workflow-mcp@latest", "/path/to/your/project", "--AutoStartDashboard"]
    }
  }
}
```

### 第2步：选择您的界面

**选项A：Web仪表板**（CLI用户必需）
```bash
npx -y @pimzino/spec-workflow-mcp@latest /path/to/your/project --dashboard
```

**选项B：VSCode扩展**（推荐VSCode用户使用）

从VSCode市场安装[Spec Workflow MCP扩展](https://marketplace.visualstudio.com/items?itemName=Pimzino.spec-workflow-mcp)。

## 📝 使用方法

只需在对话中提及spec-workflow：

- **"Create a spec for user authentication"** - 创建完整的规范工作流程
- **"List my specs"** - 显示所有规范及其状态
- **"Execute task 1.2 in spec user-auth"** - 执行特定任务

[查看更多示例 →](docs/PROMPTING-GUIDE_zh.md)

## 🔧 MCP客户端设置

<details>
<summary><strong>Augment Code</strong></summary>

在您的Augment设置中配置：
```json
{
  "mcpServers": {
    "spec-workflow": {
      "command": "npx",
      "args": ["-y", "@pimzino/spec-workflow-mcp@latest", "/path/to/your/project"]
    }
  }
}
```
</details>

<details>
<summary><strong>Claude Code CLI</strong></summary>

添加到您的MCP配置：
```bash
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替代方案（如果上述方法不起作用）：**
```bash
claude mcp add spec-workflow cmd.exe /c "npx @pimzino/spec-workflow-mcp@latest /path/to/your/project"
```
</details>

<details>
<summary><strong>Claude Desktop</strong></summary>

添加到`claude_desktop_config.json`：
```json
{
  "mcpServers": {
    "spec-workflow": {
      "command": "npx",
      "args": ["-y", "@pimzino/spec-workflow-mcp@latest", "/path/to/your/project"]
    }
  }
}
```

或者自动启动仪表板：
```json
{
  "mcpServers": {
    "spec-workflow": {
      "command": "npx",
      "args": ["-y", "@pimzino/spec-workflow-mcp@latest", "/path/to/your/project", "--AutoStartDashboard"]
    }
  }
}
```
</details>

<details>
<summary><strong>Cline/Claude Dev</strong></summary>

添加到您的MCP服务器配置：
```json
{
  "mcpServers": {
    "spec-workflow": {
      "command": "npx",
      "args": ["-y", "@pimzino/spec-workflow-mcp@latest", "/path/to/your/project"]
    }
  }
}
```
</details>

<details>
<summary><strong>Continue IDE Extension</strong></summary>

添加到您的Continue配置：
```json
{
  "mcpServers": {
    "spec-workflow": {
      "command": "npx",
      "args": ["-y", "@pimzino/spec-workflow-mcp@latest", "/path/to/your/project"]
    }
  }
}
```
</details>

<details>
<summary><strong>Cursor IDE</strong></summary>

添加到您的Cursor设置（`settings.json`）：
```json
{
  "mcpServers": {
    "spec-workflow": {
      "command": "npx",
      "args": ["-y", "@pimzino/spec-workflow-mcp@latest", "/path/to/your/project"]
    }
  }
}
```
</details>

<details>
<summary><strong>OpenCode</strong></summary>

添加到您的`opencode.json`配置文件：
```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
    }
  }
}
```
</details>

## 📚 文档

- [配置指南](docs/CONFIGURATION_zh.md) - 命令行选项，配置文件
- [用户指南](docs/USER-GUIDE_zh.md) - 全面的使用示例
- [工作流程](docs/WORKFLOW_zh.md) - 开发工作流程和最佳实践
- [界面指南](docs/INTERFACES_zh.md) - 仪表板和VSCode扩展详情
- [提示指南](docs/PROMPTING-GUIDE_zh.md) - 高级提示示例
- [工具参考](docs/TOOLS-REFERENCE_zh.md) - 完整的工具文档
- [开发](docs/DEVELOPMENT_zh.md) - 贡献和开发设置
- [故障排除](docs/TROUBLESHOOTING_zh.md) - 常见问题和解决方案

## 📁 项目结构

```
your-project/
  .spec-workflow/
    approvals/
    archive/
    specs/
    steering/
    templates/
    user-templates/
    config.example.toml
```

## 🛠️ 开发

```bash
# 安装依赖
npm install

# 构建项目
npm run build

# 以开发模式运行
npm run dev
```

[查看开发指南 →](docs/DEVELOPMENT_zh.md)

## 📄 许可证

GPL-3.0

## ⭐ Star历史

<a href="https://www.star-history.com/#Pimzino/spec-workflow-mcp&Date">
 <picture>
   <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=Pimzino/spec-workflow-mcp&type=Date&theme=dark" />
   <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=Pimzino/spec-workflow-mcp&type=Date" />
   <img alt="Star History Chart" src="https://api.star-history.com/svg?repos=Pimzino/spec-workflow-mcp&type=Date" />
 </picture>
</a>