mcp-quality-server
v1.0.1
Published
MCP服务器 - 自动化测试和代码质量监控,支持Vue2/Vue3项目
Maintainers
Readme
MCP Quality Server
🎯 专业的软件质量监控 MCP 服务器 - 自动化测试 + 代码质量分析 + 测试报告生成
✨ 核心亮点
✅ XLSX 测试用例解析 - 读取质量组提供的 Excel 测试文档
✅ Vue2/Vue3 自动化测试 - 自动执行测试用例
✅ 代码质量监控 - ESLint 静态分析,发现潜在 bug
✅ 测试报告生成 - 生成 HTML/JSON 格式的详细报告
✅ 测试覆盖率检查 - 确保测试质量达标
✅ 安全防护 - 防止路径遍历攻击
✅ MCP 标准协议 - 与 Claude Desktop 等客户端无缝集成
🚀 快速开始
# 1. 安装依赖
cd mcp-quality-server
npm install
# 2. 编译项目
npm run build
# 3. 启动服务
npm start📚 更多详情请查看: QUICKSTART.md
🛠️ 可用工具
| 工具名称 | 功能描述 | 使用场景 |
| ------------------------ | ---------------------- | ------------------------ |
| parse_test_cases | 解析 XLSX 测试用例文档 | 读取质量组提供的测试用例 |
| execute_vue_tests | 执行 Vue 项目测试 | 自动化测试执行 |
| analyze_code_quality | 分析代码质量 | 检测潜在 bug 和代码问题 |
| generate_test_report | 生成测试报告 | 生成 HTML/JSON 格式报告 |
| validate_test_coverage | 验证测试覆盖率 | 确保测试质量 |
📝 测试用例文档格式
XLSX 文件应包含以下列:
| 测试场景 | 输入参数 | 预期结果 | 优先级 | 测试类型 | | -------- | --------------------------- | -------------------- | ------ | -------- | | 用户登录 | 用户名: admin, 密码: 123456 | 登录成功,跳转到首页 | 高 | 功能测试 | | 表单验证 | 空用户名 | 显示“用户名不能为空” | 高 | 验证测试 | | 数据加载 | 点击刷新按钮 | 重新加载数据 | 中 | 功能测试 |
📚 详细说明: test-cases/README.md
📈 使用流程
graph LR
A[准备XLSX测试用例] --> B[解析测试用例]
B --> C[执行自动化测试]
C --> D[分析代码质量]
D --> E[生成测试报告]
E --> F[验证测试覆盖率]
F --> G[提交转测]👥 适用场景
🎯 场景 1:转测前质量检查
在提交转测前,自动执行所有测试用例,确保代码质量,减少 bug 数量。
🔄 场景 2:持续集成
集成到 CI/CD 流程中,每次代码提交后自动执行质量检查。
🔍 场景 3:代码审查
代码审查前,先运行代码质量分析,提前发现问题。
📚 文档导航
- QUICKSTART.md - 5 分钟快速入门指南
- USAGE.md - 详细使用文档和工具说明
- CONFIG.md - MCP 客户端配置指南
- test-cases/README.md - 测试用例文档格式说明
⚙️ 技术栈
- MCP SDK: @modelcontextprotocol/sdk ^1.0.4
- XLSX 解析: xlsx ^0.18.5
- 代码质量: ESLint ^8.57.0
- 测试工具: @vue/test-utils ^2.4.3, Vitest ^1.2.0
- 语言: TypeScript ^5.3.3
- 运行时: Node.js 20+
🔒 安全特性
- ✅ 路径遍历防护:所有文件操作都限制在工作区内
- ✅ 参数验证:严格的输入参数校验
- ✅ 错误处理:完善的异常处理机制
- ✅ 类型安全:TypeScript 强类型检查
🎓 项目结构
mcp-quality-server/
├── src/
│ └── index.ts # MCP服务器主文件(777行)
├── dist/ # 编译输出目录
├── test-cases/ # 测试用例目录
├── reports/ # 测试报告目录
├── package.json # 项目配置
├── tsconfig.json # TypeScript配置
├── README.md # 项目说明(本文件)
├── QUICKSTART.md # 快速入门
├── USAGE.md # 详细文档
└── CONFIG.md # 配置指南💡 核心优势
1. 一站式质量解决方案
从测试用例管理到测试执行,再到质量报告,全部集成在一个 MCP 服务中。
2. 自然语言交互
通过 Claude Desktop 等 MCP 客户端,使用自然语言即可调用所有功能。
3. Vue 专项优化
专门针对 Vue2/Vue3 项目优化,支持自动检测版本。
4. 可视化报告
生成美观的 HTML 报告,直观展示测试结果和质量指标。
5. 扩展性强
基于模块化设计,可轻松扩展支持更多测试框架和代码分析工具。
🎉 开始使用
- 配置 MCP 客户端:查看 CONFIG.md
- 准备测试用例:查看 test-cases/README.md
- 开始测试:在 Claude 中说 "请帮我分析项目质量"
🔧 扩展开发
想要添加新功能?查看 src/index.ts ,按照现有工具的模式添加新的工具即可。
❓ 常见问题
Q: 为什么找不到测试用例文件?
A: 使用绝对路径,确保文件存在且有读取权限。
Q: 如何集成到 CI/CD?
A: 通过 Node.js 脚本调用 MCP 工具,或者使用 MCP CLI 客户端。
Q: 支持 React 项目吗?
A: 当前专为 Vue 优化,但代码质量分析功能可用于任何 JavaScript/TypeScript 项目。
📝 许可证
MIT License - 随意使用、修改和分发
👏 贡献
欢迎提交 Issue 和 Pull Request,让这个工具变得更好!
由 ❤️ 和 TypeScript 构建
