🔍 问题现象
一直显示No tools,prompts,or resources
🔍 问题分析
- 版本问题:您的配置中使用了 @latest 版本,但这个版本有 "Invalid Version" 错误
- 服务器正常:通过测试确认 spec-workflow-mcp 服务器本身是正常工作的,能够提供4个工具
- 配置问题:MCP 配置中的版本号需要固定为 1.0.1
✅ 已修复的问题
- 版本号修复:将 @pimzino/spec-workflow-mcp@latest 改为 @pimzino/spec-workflow-mcp@1.0.1
- 配置文件创建:已创建 .spec-workflow/config.toml 配置文件
📋 可用的工具
spec-workflow-mcp 现在应该提供以下4个工具:
- spec-workflow-guide:规范工作流指导
- steering-guide:项目指导文档创建
- spec-status:规范状态显示
- approvals:审批管理
📋 最终配置
"spec-workflow": {
"command": "npx",
"args": [
"-y",
"@pimzino/spec-workflow-mcp@1.0.1",
"C:/Users/XXX/Desktop/Gitlab/1/XXX"
]
}
📋 各目录的功能详细说明
Spec Workflow 目录结构说明
概述
.spec-workflow 目录是 Spec Workflow MCP 服务器的核心配置和工作目录,用于管理项目规范文档的创建、审批和跟踪。该目录专门为前端项目(ruoyi-ui)配置,提供完整的规范文档工作流程。
目录结构
.spec-workflow/
├── config.toml # 主配置文件
├── config.example.toml # 配置示例文件
├── session.json # 会话状态文件
├── approvals/ # 审批记录目录
│ ├── customer-profile-management/
│ ├── pdf-validator/
│ └── steering/
├── archive/ # 归档目录
│ └── specs/
├── specs/ # 当前规范文档目录
│ ├── customer-profile-management/
│ ├── fault-classification/
│ ├── metrics-statistics/
│ └── pdf-validator/
├── steering/ # 项目指导文档
│ ├── product.md
│ ├── structure.md
│ └── tech.md
├── templates/ # 默认模板目录
│ ├── design-template.md
│ ├── product-template.md
│ ├── requirements-template.md
│ ├── structure-template.md
│ ├── tasks-template.md
│ └── tech-template.md
└── user-templates/ # 用户自定义模板目录
└── README.md
文件详细说明
配置文件
config.toml
- 作用: 主配置文件,定义 Spec Workflow 服务器的运行参数
- 关键配置:
projectDir = ".": 项目根目录路径port = 3000: Web 仪表板端口autoStartDashboard = true: 自动启动仪表板lang = "zh": 界面语言设置为中文
- 用途: 控制服务器行为,包括端口、语言、自动启动等设置
config.example.toml
- 作用: 配置示例文件,提供详细的配置说明和示例
- 内容: 包含所有可配置项的说明、默认值和示例配置
- 用途: 帮助用户理解如何自定义配置
session.json
- 作用: 会话状态文件,记录当前运行状态
- 内容: 包含仪表板URL、启动时间、进程ID等信息
- 用途: 跟踪服务器运行状态,支持会话恢复
审批管理
approvals/ 目录
- 作用: 存储所有审批请求和状态记录
- 结构: 按项目/功能分组存储审批记录
- 文件格式: JSON 格式的审批记录
- 用途: 跟踪文档审批流程,记录审批历史和状态
子目录说明:
customer-profile-management/: 客户档案管理功能的审批记录pdf-validator/: PDF验证器功能的审批记录steering/: 项目指导文档的审批记录
文档存储
specs/ 目录
- 作用: 存储当前活跃的规范文档
- 结构: 按功能模块分组,每个功能包含三个核心文档
- 文档类型:
requirements.md: 需求文档design.md: 设计文档tasks.md: 任务分解文档
当前功能模块:
customer-profile-management/: 客户档案管理fault-classification/: 故障分类metrics-statistics/: 指标统计pdf-validator/: PDF验证器
archive/ 目录
- 作用: 存储已完成的或历史版本的规范文档
- 用途: 版本管理,保留历史记录
- 结构: 与
specs/目录相同的组织结构
项目指导文档
steering/ 目录
- 作用: 存储项目级别的指导文档
- 文档类型:
product.md: 产品概述文档structure.md: 项目结构规范文档tech.md: 技术栈和架构文档
- 用途: 为所有功能开发提供统一的指导原则
模板系统
templates/ 目录
- 作用: 存储默认的文档模板
- 模板类型:
requirements-template.md: 需求文档模板design-template.md: 设计文档模板tasks-template.md: 任务分解模板product-template.md: 产品概述模板tech-template.md: 技术文档模板structure-template.md: 结构规范模板
- 用途: 为新文档创建提供标准化结构
user-templates/ 目录
- 作用: 用户自定义模板目录
- 功能: 允许用户覆盖默认模板
- 优先级: 用户模板优先于默认模板
- 用途: 支持项目特定的文档格式和结构
工作流程
1. 文档创建流程
- 使用模板创建新文档
- 填写文档内容
- 提交审批请求
- 等待审批通过
- 文档生效并归档
2. 审批流程
- 创建审批请求
- 审批记录存储在
approvals/目录 - 通过 Web 仪表板进行审批
- 审批完成后更新文档状态
3. 版本管理
- 活跃文档存储在
specs/目录 - 完成或过期的文档移至
archive/目录 - 保持历史记录和版本追踪
配置说明
前端项目专用配置
- 项目路径: 指向
ruoyi-ui前端项目目录 - 语言设置: 中文界面 (
lang = "zh") - 端口配置: 3000 端口用于 Web 仪表板
- 自动启动: 启用自动启动仪表板功能
模板定制
- 支持用户自定义模板覆盖默认模板
- 模板变量支持动态内容替换
- 保持与现有项目架构的一致性
使用建议
1. 文档管理
- 定期清理
archive/目录中的过期文档 - 保持
specs/目录中的文档更新 - 及时处理审批请求
2. 模板维护
- 根据项目需要定制用户模板
- 定期更新模板以反映最佳实践
- 保持模板与项目架构的一致性
3. 配置优化
- 根据团队需求调整配置参数
- 定期备份配置文件
- 监控服务器运行状态
注意事项
- 文件权限: 确保对目录有适当的读写权限
- 备份策略: 定期备份重要的配置和文档
- 版本控制: 将配置文件纳入版本控制系统
- 安全考虑: 审批记录可能包含敏感信息,注意访问控制
技术支持
如需技术支持或配置帮助,请参考:
config.example.toml中的详细配置说明user-templates/README.md中的模板定制指南- Web 仪表板中的帮助文档