规范驱动开发服务器

OpenSpec MCP是一个规范驱动开发服务器,提供实时仪表盘和审批工作流,用于管理变更提案、任务跟踪和规范验证。

  • by Lumiaqian
  • TypeScript
  • 本地部署
  • 31 星标
  • 更新于
在 GitHub 查看 Lumiaqian/openspec-mcp

使用说明

OpenSpec MCP

MCP(模型上下文协议)服务器 开放规范 -规范驱动的开发,具有实时仪表板和审批工作流。

特性

  • MCP工具:完整的OpenSpec CLI功能作为MCP工具公开
  • 审查制度:添加、回复、解决对提案/设计的审查意见
  • 任务跟踪:解析tasks.md并实时跟踪进度
  • 审批工作流程:请求、批准和拒绝变更建议
  • 跨服务文档:查看单个服务项目中的跨服务设计文档
  • 网络仪表盘:具有实时更新和Markdown渲染的可视化管理界面

快速开始

1.添加到MCP配置中

Claude Code CLI(推荐-使用当前目录):

claude mcp add openspec -- npx openspec-mcp

带仪表板的Claude代码CLI:

claude mcp add openspec -- npx openspec-mcp --with-dashboard

带特定项目路径的Claude Code CLI:

claude mcp add openspec -- npx openspec-mcp /path/to/your/project

克劳德桌面/光标/其他:

{
  "mcpServers": {
    "openspec": {
      "command": "npx",
      "args": ["-y", "openspec-mcp"]
    }
  }
}

使用仪表板:

{
  "mcpServers": {
    "openspec": {
      "command": "npx",
      "args": ["-y", "openspec-mcp", "--with-dashboard"]
    }
  }
}

2.在对话中使用

# List all changes
"List all openspec changes"

# Show change details
"Show me the add-user-auth change"

# Update task status
"Mark task 1.1 as done in add-user-auth"

# Request approval
"Request approval for add-user-auth from @reviewer"

可用提示(新!)

通过上下文感知提示直接利用客户的人工智能能力(Claude、Codex)。

提示 描述
analyze-project 项目架构和堆栈的深入分析
review-change 通过链接的规格对变更进行智能审查

可用工具

指南和背景

工具 说明
openspec_get_instructions 获取AGENTS.md使用指南
openspec_get_project_context 获取project.md上下文
openspec_analyze_context 分析项目结构和堆栈
openspec_ai_analyze_context AI增强的上下文分析

管理

工具 说明
openspec_list_changes 列出所有变更建议
openspec_list_specs 列出所有规格
openspec_show_change 显示更改详细信息
openspec_show_spec 显示规格详细信息

验证

工具 说明
openspec_validate_change 验证更改
openspec_validate_spec 验证规格
openspec_validate_all 批量验证

档案

工具 说明
openspec_archive_change 存档已完成的更改

任务

工具 说明
openspec_get_tasks 获取任务和进度
openspec_update_task 更新任务状态
openspec_batch_update_tasks 批量更新任务状态
openspec_get_progress_summary 获取所有更改进度

批准

工具 说明
openspec_get_approval_status 获取审批状态
openspec_request_approval 请求批准
openspec_approve_change 批准更改
openspec_reject_change 拒绝更改
openspec_list_pending_approvals 列出待批准事项

评论

工具 说明
openspec_add_review 在提案/设计/任务中添加审查意见
openspec_list_reviews 列出带有过滤器的评论
openspec_reply_review 对评论的回复
openspec_resolve_review 将审核标记为已解决
openspec_get_review_summary 获取评论统计数据和屏蔽问题

模板

工具 说明
openspec_list_templates 列出可用模板
openspec_create_change 从模板创建更改
openspec_preview_template 预览模板内容

发电机

工具 说明
openspec_generate_proposal 根据需求生成提案
openspec_save_proposal 保存生成的提案

钩子

工具 说明
openspec_setup_hooks 为项目设置git挂钩

交叉服务

工具 说明
openspec_list_cross_service_docs 列出跨服务文档
openspec_read_cross_service_doc 阅读跨服务文档

跨服务文档

对于共享共同点的多服务项目 .cross-service/ 目录(例如,在Git工作树中),配置您的 proposal.md 正面:

---
crossService:
  rootPath: "../../../../.cross-service" # Relative to change directory
  documents:
    - design.md
    - flows.md
    - services.yaml
  archivePolicy: snapshot # 'snapshot' (default) or 'reference'
---
# Your proposal content...

仪表板将显示一个“跨服务”选项卡,其中包含:

  • design.md/flows.md:渲染为Markdown
  • services.yaml:带有服务状态、更改和部署顺序的可视卡视图

审批工作流程

draft -> pending_approval -> approved -> implementing -> completed -> archived
                         -> rejected -> draft (revise and resubmit)

审批记录存储在 openspec/approvals/<change-id>.json.

CLI选项

openspec-mcp [path] [options]

Arguments:
  path                    Project directory path (default: current directory)

Options:
  --dashboard             Start web dashboard only (HTTP mode)
  --with-dashboard        Start MCP server with web dashboard
  -p, --port <number>     Dashboard port (default: 3000; auto-increments if busy, 0 for random)
  -V, --version           Output version number
  -h, --help              Display help

例子

# MCP server only (uses current directory)
openspec-mcp

# MCP server with specific project
openspec-mcp /path/to/project

# Dashboard only
openspec-mcp --dashboard

# MCP server + Dashboard
openspec-mcp --with-dashboard

# Dashboard on custom port
openspec-mcp --dashboard --port 8080

网络仪表盘

仪表板提供了一个可视化界面,用于管理更改、跟踪任务和处理审批。

仪表板页面

路线 描述
/ 统计数据和最新变化概述
/kanban 拖放看板板
/changes 列出所有更改及其进度
/changes/:id 使用规格和任务更改详细信息
/qa QA Runner仪表板
/context 项目分析和技术栈
/specs 浏览规格
/approvals 审批队列管理

特性

  • 实时更新:WebSocket连接用于实时进度和查看更新
  • 用看板图:支持拖放的6列工作流(待办事项->已发布)
  • QA仪表板:直接从UI监控和触发质量检查
  • 上下文分析:自动检测技术栈并可视化目录结构
  • 任务管理:直接从UI切换任务状态
  • 审批操作:批准/拒绝带有注释的更改
  • 进度可视化:进度条和状态徽章
  • 评审管理:使用“打开/已解决”选项卡查看、解决和跟踪评论
  • 跨服务文档:使用visual services.yaml显示查看跨服务设计文档
  • Markdown渲染:完全支持Markdown的提案和设计

发展

# Install dependencies
npm install

# Build
npm run build

# Development mode
npm run dev

# Run tests
npm test

需求

  • Node.js>=20.0.0
  • OpenSpec命令行界面(npm install -g @fission-ai/openspec)

许可证

麻省理工学院