sentry-sdk-skill-creator について
新しいプラットフォーム向けに、調査に基づく Sentry SDK skill bundle を作成するためのスキルです。SDK の調査、ウィザードやリファレンスの作成、検証、リポジトリ文書の更新を案内します。
主な機能
- 01SDK 機能マトリクスの作成
- 02公式文書とソースの調査
- 03ウィザード中心のセットアップ案内
- 04機能別リファレンスの作成
- 05API の検証とレビュー
- 06リポジトリ登録のチェックリスト
活用シーン
- 01新しい言語向けの Sentry SDK skill の追加
- 02フレームワーク対応の sentry-agent-skills への追加
- 03SDK skill のパターンの別 SDK への移植
インストール
コマンドをコピーしてターミナルで実行します。
npx skills add https:/ / github.com/ getsentry/ sentry-agent-skills --skill sentry-sdk-skill-creatorインストール後、Claude Code で/sentry-sdk-skill-creatorを入力して読み込まれたか確認します。
同梱ファイル
SKILL.md と一緒にインストールされる参考資料やスクリプト。
references/philosophy.mdquality-checklist.mdresearch-playbook.md詳細
Sentry SDK スキルバンドルの作成
完全な、調査に基づく SDK スキルバンドルを作成します。メインのウィザード SKILL.md と、SDK がサポートするすべての機能の柱を詳しく解説するリファレンスファイルを含めます。
このスキルを使う場面
- 新しいプラットフォーム向けに「Sentry SDK スキルを作成して」と依頼された場合
- sentry-agent-skills に「[言語/フレームワーク]のサポートを追加して」と依頼された場合
- 新しい
sentry-<platform>-sdkスキルバンドルを作成する場合 - Sentry SDK のスキルパターンを新しい SDK に移植する場合
まず
${SKILL_ROOT}/references/philosophy.mdを読んでください。このファイルでは、このスキルが実装するバンドルのアーキテクチャ、ウィザードのフロー、設計原則を定義しています。
フェーズ 1:SDK の特定
どの SDK 向けのスキルを作成するのかを特定します。
# What SDK? What's the package name?
# Examples: sentry-go, @sentry/sveltekit, sentry-python, sentry-ruby, sentry-cocoa
機能マトリックスを作成し、この SDK が Sentry のどの機能の柱をサポートするかを確認します。
| 柱 | ドキュメントを確認 | 備考 |
|---|---|---|
| エラーモニタリング | 常に利用可能 | 必須の基本機能 |
| トレーシング/パフォーマンス | 通常は利用可能 | span API を確認 |
| プロファイリング | SDK によって異なる | 削除されている場合や、実験的な機能の場合があります |
| ロギング | 比較的新しい機能 | 最低バージョンを確認 |
| メトリクス | 比較的新しい機能 | ベータ版/実験的な機能の場合があります |
| Crons | バックエンドのみ | フロントエンド SDK では利用できません |
| セッションリプレイ | フロントエンドのみ | バックエンド SDK では利用できません |
| AI モニタリング | 一部の SDK | 通常は JS と Python のみ |
既存の SDK スキルを参照して、目標とする品質水準を把握します。
ls skills/sentry-*-sdk/ 2>/dev/null
# Read 1-2 existing SDK skills for pattern reference
フェーズ 2:調査
**最も重要なフェーズです。**スキルの品質は、正確で最新の API 知識に完全に依存します。記憶を頼りにスキルを書かないでください。すべての機能について、公式ドキュメントに基づいて調査してください。
調査戦略
機能領域ごとに 1 つずつ、outputFile を指定した claude ツールを使って並列調査タスクを開始します。各タスクでは、次の作業を行います。
- その機能に関する Sentry 公式ドキュメントのページを確認する
- SDK の GitHub リポジトリで、ソースコードレベルの API を検証する
- 詳細な調査結果を専用の調査ファイルに記録する
プロンプトのテンプレートやファイル名の規則を含む詳細な調査実行計画については、${SKILL_ROOT}/references/research-playbook.md を読んでください。
Sentry ウィザードの調査
機能の調査に入る前に、Sentry ウィザード CLI がこのフレームワークをサポートしているか確認します。
# Check the SDK's docs landing page for wizard instructions
# Visit: https://docs.sentry.io/platforms/<platform>/
# Look for: "npx @sentry/wizard@latest -i <integration>"
ウィザードとの統合が存在する場合は、次の点を記録します。
- ウィザードの正確なコマンドと
-iフラグ - ウィザードが作成/変更するもの(ファイル、設定、ビルドプラグイン)
- ウィザードが対話形式で認証を処理すること。ログイン、組織/プロジェクトの選択、認証トークンの作成/ダウンロードはすべて自動で行われます
- ウィザードがソースマップのアップロードを設定するかどうか。これはフロントエンド SDK では重要です
- これらの情報は、生成するスキルのフェーズ 3 に「オプション 1:ウィザード(推奨)」として記載します
**これが重要な理由:**ウィザードは、ログイン、組織/プロジェクトの選択、認証トークンの取得といった認証フロー全体と、ソースマップのアップロード設定を自動で処理します。ソースマップがないと、本番環境のスタックトレースには難読化されたコードが表示されるため、フロントエンドのデバッグで Sentry はほとんど役に立ちません。また、認証トークンがなければソースマップをアップロードできません。ウィザードを使えば、両方を一度に正しく設定できるため、最も信頼性の高い方法です。
調査のバッチ処理
調査タスクをトピック領域ごとにまとめます。可能な場合は並行して実行します。
| バッチ | トピック | 出力ファイル |
|---|---|---|
| 1 | セットアップ、設定、すべての初期化オプション、フレームワークの検出 | research/<sdk>-setup-config.md |
| 2 | エラーモニタリング、パニック/例外のキャプチャ、スコープ、情報の付加 | research/<sdk>-error-monitoring.md |
| 3 | トレーシング、プロファイリング(対応している場合) | research/<sdk>-tracing-profiling.md |
| 4 | ロギング、メトリクス、cron(対応している場合) | research/<sdk>-logging-metrics-crons.md |
| 5 | セッションリプレイ(フロントエンドのみ)、AI モニタリング(対応している場合) | research/<sdk>-replay-ai.md |
重要: 各調査タスクには、出力をファイルに書き込むよう指示してください(outputFile パラメーターを使用)。調査結果をインラインで受け取らないでください。結果は大きく(各 500~1200 行)、ワーカーが後でディスクから読み込みます。
調査品質ゲート
次に進む前に、各調査ファイルを確認してください。
- 実際の内容が含まれている(Claude の作業メモだけではない)
- 実際の API 名を使ったコード例が含まれている
- 最低 SDK バージョンが記載されている
- フレームワーク固有の違いが網羅されている
# Quick verification
for f in research/<sdk>-*.md; do
echo "=== $(basename $f) ==="
wc -l "$f"
grep -c "^#" "$f" # should have multiple headings
done
100 行未満の調査タスクは再実行してください。サイレントに失敗した可能性があります。
フェーズ 3:メインの SKILL.md を作成する
メインの SKILL.md では、理念ドキュメントにある4 フェーズのウィザードを実装します。内容を絞り込み、メインファイルではウィザードの流れ、クイックスタート設定、フレームワークの表、リファレンスへの案内を扱います。個々の機能の詳細はここではなく、references/ ファイルに記載します。十分な情報を盛り込みつつ、重複は避けてください。
まずコンテキストを集める
書き始める前に、既存のスキルを調べるか、調査担当を実行して、規約を把握してください。
- Frontmatter のパターン(name、description、license)
- 「このスキルを呼び出すタイミング」のトリガーフレーズ
- 表の形式とコード例のスタイル
- トラブルシューティング表の規約
SKILL.md の構成
---
name: sentry-<platform>-sdk
description: Full Sentry SDK setup for <Platform>. Use when asked to "add Sentry
to <platform>", "install <package>", or configure error monitoring, tracing,
[features] for <Platform> applications. Supports [frameworks].
license: Apache-2.0
---
# Sentry <Platform> SDK
## Invoke This Skill When
[trigger phrases]
## Phase 1: Detect
[bash commands to scan project — package manager, framework, existing Sentry, frontend/backend]
## Phase 2: Recommend
[opinionated feature matrix with "always / when detected / optional" logic]
## Phase 3: Guide
### Option 1: Wizard (Recommended) ← if wizard exists for this framework
[wizard command, what it creates/modifies table, skip-to-verification note]
### Option 2: Manual Setup ← always include
### Install
### Quick Start — Recommended Init
### Source Maps Setup ← required for frontend/mobile SDKs
### Framework Middleware (if applicable)
### For Each Agreed Feature
[reference dispatch table: feature → ${SKILL_ROOT}/references/<feature>.md]
## Configuration Reference
[key init options table, environment variables]
## Verification
[test snippet]
## Phase 4: Cross-Link
[detect companion frontend/backend, suggest matching SDK skills]
## Troubleshooting
[common issues table]
メインの SKILL.md に関する主な原則
- 簡潔にする — 詳細はここではなく、リファレンスに記載します
- フレームワーク SDK ではウィザードを優先する — Sentry ウィザードがこのフレームワークに対応している場合は、手動セットアップより先に「オプション 1:ウィザード(推奨)」として提示します。ウィザードは、認証フロー全体(ログイン、組織/プロジェクトの選択、認証トークンの作成)、ソースマップのアップロード、ビルドツールのプラグイン、フレームワーク固有の接続設定を、1 回の対話型ステップで処理します。全体的なパターンについては
${SKILL_ROOT}/references/philosophy.mdを参照してください。 - フロントエンド/モバイルではソースマップが必須 — 手動セットアップの手順には、ソースマップのアップロード設定(ビルドツールのプラグインと環境変数)を含めます。ソースマップがないと、本番環境のスタックトレースは読み取れない圧縮コードになります。
- 検出コマンドは実際に動作するものにする — 実際のプロジェクトでテストしてください
- 推奨の方針を明確にする — 「常に」「X を検出した場合」などとし、「検討してもよい」などの曖昧な表現は使いません
- クイックスタート設定では、適切なデフォルト値を使ってできるだけ多くの機能を有効にする
- フレームワークのミドルウェア表 — 正確な import パス、ミドルウェアの呼び出し、固有の注意点を記載します
- 積極的に相互リンクする — Go バックエンドならフロントエンドも提案します。Svelte フロントエンドならバックエンドも提案します。
フェーズ 4:リファレンスファイルを作成する
SDK が対応する機能の柱ごとに、リファレンスファイルを 1 つ作成します。これらは詳細な解説であり、メインの SKILL.md より長くてもかまいません。
リファレンスファイルの構成
# <Feature> — Sentry <Platform> SDK
> Minimum SDK: `<package>` vX.Y.Z+
## Configuration
## Code Examples
### Basic usage
### Advanced patterns
### Framework-specific notes (if applicable)
## Best Practices
## Troubleshooting
| Issue | Solution |
|-------|----------|
優れたリファレンスに必要なもの
品質基準の全項目については ${SKILL_ROOT}/references/quality-checklist.md を参照してください。
主なポイント:
- 動作するコード例 — 擬似コードや途中で省略したコード例ではない
- 設定オプションの表 — 型、デフォルト値、最低バージョン
- 各パターンにつき完全な例を 1 つ — 同じ内容のバリエーションを 5 つも示さない
- フレームワーク固有の注意点 — フレームワークによって動作が異なる場合は明記する
- 最低 SDK バージョンを冒頭に記載 — 必ず記載する
- 制限を正直に記載する — Go のプロファイリングのように機能が削除された場合は、その旨を記載する
機能固有のガイダンス
| 機能 | 主な記載事項 |
|---|---|
| エラー監視 | キャプチャ API、パニック/例外からの復旧、スコープ、拡充(タグ/ユーザー/パンくず)、エラーチェーン、BeforeSend、フィンガープリント |
| トレーシング | サンプルレート、カスタムスパン、分散トレーシング、フレームワークのミドルウェア、操作タイプ |
| プロファイリング | サンプルレートの設定、トレースへの紐付け方、または「削除済み/利用不可」と正直に記載 |
| ロギング | 有効化フラグ、ロガー API、一般的なロギングライブラリとの連携、フィルタリング |
| メトリクス | カウンター/ゲージ/分布 API、単位、属性、カーディナリティに関するベストプラクティス |
| Cron | チェックイン API、モニター設定、スケジュールの種類、ハートビートのパターン |
| セッションリプレイ | リプレイの連携、サンプルレート、プライバシーマスキング、キャンバス/ネットワークの記録 |
フロントエンド/モバイル SDK に関する注意: ソースマップのアップロード設定は、リファレンスファイルではなく、メインの SKILL.md(フェーズ 3:ガイド)に記載してください。これはセットアップの中核的な手順であり、フロントエンドの本番デプロイでは必ず必要になります。ビルドツールのプラグイン、必要な環境変数(
SENTRY_AUTH_TOKEN、SENTRY_ORG、SENTRY_PROJECT)を説明し、.envを.gitignoreに追加してください。
フェーズ 5:すべてを検証する
このフェーズを省略しないでください。 SDK の API は頻繁に変更されます。調査結果には幻覚が含まれることがあります。作業者が設定キーを捏造することもあります。
API の検証
SDK の実際のソースコードに基づいて、専用の検証を実施します。
Research prompt: "Verify these specific API names and signatures against
the <SDK> GitHub repo source code: [list every API from the skill files]"
よくある間違い:
- 設定オプション名の大文字・小文字の誤り(
SendDefaultPiiとSendDefaultPII) - 実在しない設定キーの捏造(
experimental.tracingが実在するか確認してください) - 最新の代替 API ではなく、非推奨 API を使用(
configureScope→getIsolationScope) - 削除済みの機能を利用可能と記載(Go SDK のプロファイリング)
- 最小バージョン番号の誤り
レビュー
完成したスキルバンドルをレビューします:
- コード例の技術的な正確性
- メインの SKILL.md とリファレンスファイル間の一貫性
- リポジトリ内の既存 SDK スキルとの一貫性
- Agent Skills 仕様への準拠(フロントマター、命名)
レビュー指摘事項の修正
優先度に従ってトリアージします:
- P0:誤解を招く記述(削除済み機能の宣伝など)— 直ちに修正
- P1:API の誤り、非推奨メソッド — マージ前に修正
- P2:スタイルの不統一、バージョンに関する細かな指摘 — すぐに対応できる場合は修正
- P3:対応不要
フェーズ 6:登録してドキュメントを更新する
スキルがレビューに合格したら:
- README.md を更新 — SDK Skills テーブルに追加
- AGENTS.md を更新 — 理念ドキュメントまたはスキルカテゴリのセクションに必要な場合
- 使用例を追加 — Usage セクションに起動フレーズを追加
- バンドルのパターンを文書化 — 新しい SDK の場合は、references/ 構成について記載
コミット戦略
主要な作業ごとに個別のコミットを作成します:
feat(<platform>-sdk): add sentry-<platform>-sdk main SKILL.md wizardfeat(<platform>-sdk): add reference deep-dives for all feature pillarsdocs(readme): add sentry-<platform>-sdk to available skillsfix(skills): address review findings(該当する場合)
チェックリスト
スキルを完成とする前に、以下を確認してください。
- Philosophy ドキュメントを読み、内容に従っている
- すべての機能の柱を公式ドキュメントに基づいて調査している(記憶に頼っていない)
- 調査ファイルを検証している(実際の内容があり、API が正しく、それぞれ 100 行を超えている)
- メインの SKILL.md が要点に絞られている — ウィザードの流れ、クイックスタート、リファレンスへの案内が中心で、詳細はリファレンスに記載している
- メインの SKILL.md でウィザードの 4 つのフェーズをすべて実装している
- ウィザード CLI を確認している — 対応している場合は「オプション 1:ウィザード(推奨)」として提示し、認証フローとソースマップの利点を説明している
- 手動セットアップの手順で、ソースマップ/デバッグシンボルのアップロードを扱っている(フロントエンド/モバイル SDK)
- 対応する機能の柱ごとにリファレンスファイルがある
- SDK のソースコードに照らして API を検証している
- レビューを完了し、指摘事項に対処している
- プロファイリング/削除された機能について、誇張せず正直に記載している
- 関連するフロントエンド/バックエンドスキルへの相互リンクがある
- README.md を更新している
- すべてのコミットを、内容が分かる説明的なメッセージに整えている