mcpField
O
opik-integrations-auditor

opik-integrations-auditor

github.com/vincentkocテスト・品質11137 回インストール2 日前に更新
リポジトリ

opik-integrations-auditor について

Opik Integrations Auditorは、Opik連携を証拠に基づいて反復可能な形で監査・文書化するスキルです。Python、TypeScript、バックエンドのOTEL/API間で動作やテスト、ドキュメントを比較できます。

主な機能

  1. 01連携一覧とパターン分類
  2. 02技術面をまたぐ比較マトリクス
  3. 03動作・データ契約のレビュー
  4. 04バックエンド互換性の検証
  5. 05テスト網羅率と不足の分析
  6. 06ドキュメント・テスト計画

活用シーン

  1. 01既存のOpik連携の監査
  2. 02新しい連携の設計
  3. 03Python、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 統合監査

目的

再現可能なエビデンス優先のワークフローで、Python、TypeScript、バックエンドの OTEL/API サーフェス全体にわたる Opik 統合を監査、比較、文書化します。

使用する場面

次のようなタスクでは、このスキルを使用してください。

  • 既存の Opik 統合の動作、網羅性、ドキュメントの品質をレビューする
  • 新しい統合を設計または実装する
  • Python、TypeScript、OTEL/API 全体の統合パターンのドキュメントを作成する
  • コード、テスト、ドキュメント間のギャップを特定する

必須の成果物

回答(または依頼された場合はファイル)に、次の成果物を含めてください。

  1. 統合のインベントリ表
  2. 統合ごとのパターン分類
  3. サーフェス横断比較マトリクス(Python / TypeScript / OTEL/API)
  4. 指摘事項の一覧(バグ/リスク/ギャップ)
  5. ドキュメントのパッチ計画
  6. テスト計画(単体テスト+統合テスト+E2E)

ワークフロー

  1. インベントリを作成し、統合ごとにパターンを分類します。
  2. 動作契約(キャプチャ、ストリーミング、エラー、フラッシュ、スパン階層)を抽出します。
  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
  • サブエージェントのプロンプトテンプレート: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

コメント