mcpField
O
opik-integrations-auditor

opik-integrations-auditor

github.com/vincentkoc测试与质量11137 次安装2 天前更新
代码仓库

关于 opik-integrations-auditor

Opik Integrations Auditor 是用于审查和记录 Opik 集成的可重复、证据优先 Skill，帮助团队比较 Python、TypeScript 与后端 OTEL/API 的行为、测试和文档。

主要功能

  1. 01集成清单与模式分类
  2. 02跨技术面的比较矩阵
  3. 03行为与数据契约审查
  4. 04后端兼容性验证
  5. 05测试覆盖与缺口分析
  6. 06文档和测试计划

适用场景

  1. 01审计现有 Opik 集成
  2. 02规划新的集成
  3. 03比较 Python、TypeScript 与 OTEL/API 技术面
  4. 04查找代码、测试和文档之间的缺口

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/vincentkoc/dotskills --skill opik-integrations-auditor

安装后在 Claude Code 中输入/opik-integrations-auditor确认已加载。

包含的文件

除 SKILL.md 外，安装时一起下载的参考资料和脚本。

agents/
openai.yaml
references/
doc-template.md
evidence-collection.md
matrix-and-rubric.md
patterns.md
subagent-prompts.md
testing-checklist.md

详细介绍

Opik 集成审计员

目的

通过可重复、以证据为先的工作流，审计、比较并记录 Opik 在 Python、TypeScript 和后端 OTEL/API 各方面的集成。

适用场景

在任务涉及以下内容时使用此技能：

  • 审查现有 Opik 集成的行为、覆盖范围或文档质量
  • 设计或实现新的集成
  • 编写涵盖 Python、TypeScript 和 OTEL/API 的集成模式文档
  • 识别代码、测试和文档之间的差距

必需的输出

在回复中（或按要求写入文件）产出以下内容：

  1. 集成清单表
  2. 各集成的模式分类
  3. 跨界面对比矩阵（Python / TypeScript / OTEL/API）
  4. 发现的问题列表（错误/风险/差距）
  5. 文档补丁计划
  6. 测试计划（单元测试 + 集成测试 + 端到端测试）

工作流

  1. 建立清单，并对各集成的模式进行分类。
  2. 提取行为契约（采集、流式处理、错误、刷新、span 层级）。
  3. 提取数据契约（用量、元数据/标签、线程传递）。
  4. 验证后端兼容性（OTEL 端点/协议/映射规则）。
  5. 检查测试覆盖范围及缺失的边缘案例。
  6. 使用统一模板更新文档。

按需加载参考资料

  • 矩阵架构和评分标准：references/matrix-and-rubric.md
  • 模式定义：references/patterns.md
  • 证据收集路径和命令：references/evidence-collection.md
  • 文档更新模板：references/doc-template.md
  • 测试检查清单：references/testing-checklist.md
  • 子 Agent 提示词模板：references/subagent-prompts.md

输入

  • 集成范围（特定集成或完整清单）
  • 要比较的目标界面（Python、TypeScript、OTEL/API）
  • 相关仓库路径及分支/差异范围
  • 输出要求（表格详略程度、文档补丁格式、测试深度）

输出

  • 清单和对比矩阵
  • 发现的问题及风险摘要
  • 文档补丁计划
  • 列明缺失覆盖范围的测试计划

默认证据位置（如仓库有所不同，可覆盖）

  • Python：
    • sdks/python/src/opik/integrations
    • sdks/python/design/INTEGRATIONS.md
    • sdks/python/design/TESTING.md
  • TypeScript：
    • sdks/typescript/design/INTEGRATIONS.md
    • sdks/typescript/design/TESTING.md
  • 后端 OTEL：
    • apps/opik-backend/src/main/java/com/comet/opik/api/resources/v1/priv/OpenTelemetryResource.java
    • apps/opik-backend/src/main/java/com/comet/opik/domain/OpenTelemetryService.java
    • apps/opik-backend/src/main/java/com/comet/opik/domain/OpenTelemetryMapper.java
    • apps/opik-backend/src/main/java/com/comet/opik/domain/mapping/OpenTelemetryMappingRuleFactory.java
    • apps/opik-backend/docs/integrations.md

评论

支持 Markdown