SuperAPI AI 工具集

zammad-mcp-quality

编程与开发

查看项目

更新于 11-13 13:40

技能介绍

用途

该技能用于保障 Zammad MCP 项目贡献质量,核心目标包括:防止 CodeRabbit 反复标记同类问题、提供可执行的自查清单、将项目经验沉淀为可查阅的参考文档,并通过反馈闭环实现持续改进。

主要能力

  • 提交前自查清单:pre-pr-checklist.md 提供每次 PR 前使用的快速自查项,官方称可减少 60%–70% 的评审迭代。
  • CodeRabbit 经验库:coderabbit-learnings.md 汇总 PR 评审反馈,作为持续更新的知识库和索引。
  • 分页模式指南:pagination-patterns.md 说明 MCP 服务器分页所需的元数据字段、常见错误与修复、保持 JSON 有效性的截断方式,并附代码库示例。
  • 错误处理指南:error-handling-guide.md 提供错误消息模板、HTTP 状态码映射、ID 与 number 混淆问题(Issue #99)、配置错误及应避免的反模式。
  • 类型注解标准:type-annotation-standards.md 覆盖 Python 3.10+ 类型语法、参数遮蔽修复、Pydantic 模型类型、通过 get_client() 对 ZammadClient | None 做类型收窄,以及 MyPy 配置。

使用方式

在开发前按需阅读对应参考文档;开发中遵循既定模式(现代类型语法、可操作的错误消息、正确的分页元数据、命名不遮蔽);创建 PR 前必须过一遍 pre-pr-checklist.md。质量校验可运行:

# 从项目根目录
mise run validate           # 开发循环:lint + 受影响测试
mise run validate-release   # PR 前:lint + 全量测试(86% 覆盖率下限)+ 构建

注意:./scripts/quality-check.sh 会格式化、自动修复并写报告,且已运行 pytest,不要与另一次 pytest 串联。收到 CodeRabbit 评审后,先修复问题,再理解模式、查阅文档、搜索代码库中的同类实例,必要时更新经验库。维护者每月复盘最近 10 个已合并 PR,更新 coderabbit-learnings.md 与检查清单,预计每月约 30 分钟。

适用场景

适用于 Zammad MCP 项目的 PR 提交前自查、MCP 工具实现、分页功能添加、错误处理改造、回应 CodeRabbit 反馈、新人上手了解质量标准和月度质量复盘。

限制

scripts/extract_feedback.py 目前为占位实现,所有函数仅打印 [TODO] 并返回空数据,不可依赖其输出;调用须使用 uv(如 uv run scripts/extract_feedback.py --prs 10 --output references/coderabbit-learnings.md),计划在第三阶段实现自动化。技能还提供质量指标参考(如每个 PR 的 CodeRabbit 评论目标少于 5 条、测试覆盖率下限 86%),并说明其与 AGENTS.md、.coderabbit.yaml、mcp-builder 技能的分工互补关系。