项目简介 'Spec Workflow MCP' 服务器是一个为AI辅助软件开发设计的后端服务，它实现了 Model Context Protocol (MCP)。其核心功能是向大型语言模型（LLM）客户端提供标准化的上下文信息、可调用的外部功能和可定制的交互模式。它帮助开发者以结构化的方式管理软件开发项目，包括需求、设计、任务、审批流程以及项目指导文档。此外，它还提供了实时Web仪表盘和VSCode扩展，方便开发者监控和管理项目进展。
主要功能点
- 结构化开发工作流： 支持需求(Requirements) → 设计(Design) → 任务(Tasks) 的顺序规范创建。
- 资源托管与数据访问： 管理项目中的规范文档（如需求、设计、任务），并提供LLM访问这些文档内容的能力。
- 工具注册与执行： 提供一系列AI可调用的工具，例如：
  - 工作流指南 ('spec-workflow-guide', 'steering-guide')： 提供工作流的详细说明。
  - 规范管理 ('create-spec-doc', 'spec-list', 'spec-status', 'manage-tasks')： 创建、列出、查看状态和管理规范文档及任务。
  - 上下文与模板 ('get-template-context', 'get-steering-context', 'get-spec-context')： 获取文档模板和现有文档的上下文信息。
  - 指导文档 ('create-steering-doc')： 创建产品、技术和架构指导文档。
  - 审批系统 ('request-approval', 'get-approval-status', 'delete-approval')： 提交、查询和管理审批请求。
- Prompt 模板定义与渲染： 预定义Prompt模板，支持LLM生成定制化的交互内容。
- 实时Web仪表盘和VSCode扩展： 提供直观的UI界面，实时监控项目状态、任务进度和审批流程，方便开发者直接在开发环境中操作。
- 多语言支持： 仪表盘、VSCode扩展和MCP工具均支持多种语言（如中文、英文、日文等）。
安装步骤 'Spec Workflow MCP' 服务器作为一个Node.js应用程序发布在npm上，通常通过'npx'命令运行。无需手动安装依赖，'npx'会在运行时自动处理。
1. 确保Node.js和npm已安装： 在命令行中运行 'node -v' 和 'npm -v' 检查。如果未安装，请访问Node.js官网下载安装。
2. 选择您的工作目录： 导航到您的项目根目录，这是MCP服务器将管理规范和文件的位置。
MCP服务器配置 MCP服务器需要通过MCP客户端（如Augment Code, Claude Code CLI, Cursor IDE等）启动。以下是一些常见客户端的配置示例（JSON格式，配置在MCP客户端的设置中，请根据您的客户端类型进行调整）：
- 在MCP客户端中配置MCP服务器： 大多数MCP客户端通过JSON配置来定义外部MCP服务器。您需要指定服务器的启动命令 ('command') 及其参数 ('args')。
```
{
  "mcpServers": {
    "spec-workflow": {
      "command": "npx",
      "args": ["-y", "@pimzino/spec-workflow-mcp@latest", "/path/to/your/project"]
    }
  }
}
```
  - 'spec-workflow'：您为该MCP服务器定义的名称，LLM客户端将使用此名称引用它。
  - 'command': 'npx' (Node.js包执行器，用于运行npm上的包而无需全局安装)。
  - 'args':
    - '-y': 跳过'npm'的确认提示，以便静默安装。
    - '@pimzino/spec-workflow-mcp@latest': 指定要运行的MCP服务器包及其版本。
    - '/path/to/your/project': 您的项目根目录的绝对路径。
      - 重要提示： 请将 '/path/to/your/project' 替换为您的实际项目路径。在一些CLI客户端中（例如'claude mcp add'），您可能需要在路径前添加 '--' 分隔符，以确保路径参数正确传递给脚本而非'npx'自身。
- 附加配置选项： 您可以向'args'数组添加额外的参数来控制服务器行为：
  - '--AutoStartDashboard': 自动启动Web仪表盘并使其与MCP服务器同步运行。
  - '--port <number>': 指定Web仪表盘的端口号（例如 '3456'）。如果未指定，将使用一个随机的临时端口。
  示例（带自动启动仪表盘）：
```
{
  "mcpServers": {
    "spec-workflow": {
      "command": "npx",
      "args": ["-y", "@pimzino/spec-workflow-mcp@latest", "/path/to/your/project", "--AutoStartDashboard"]
    }
  }
}
```
基本使用方法 一旦MCP服务器在您的MCP客户端中配置并启动，您可以通过与LLM客户端对话来使用它。LLM会根据您的指令，自动调用MCP服务器提供的工具和Prompt。
- 创建规范： 直接告诉LLM您想创建什么，例如：
  - "创建一个用户认证功能的规范"
  - "为支付系统构建一个完整的需求→设计→任务规范"
  - "根据我的现有产品需求文档 (PRD) 创建一个完整的规范工作流"
- 获取信息： 询问LLM项目或规范的当前状态：
  - "列出我的所有规范"
  - "显示用户认证功能的进度"
- 执行任务： 让LLM执行特定任务：
  - "执行用户认证规范中的任务1.2"
  - "将用户认证规范中的任务1.2标记为已完成"
- 使用仪表盘/VSCode扩展： 如果您自动启动了Web仪表盘或安装了VSCode扩展，您可以在Web浏览器或VSCode侧边栏中实时查看项目概览、任务进度和审批请求。Web仪表盘对于CLI用户是强制性的，VSCode用户可以通过扩展直接在IDE中获得相同功能。

关键词

信息