origin-api について
Cursor Origin APIを扱う開発者向けのドキュメント案内スキルです。関連するAPI仕様への誘導に加え、リポジトリ種別、イベント購読、Webhook検証、スコープ、不透明な識別子に関する規則を示します。
主な機能
- 01関連APIドキュメントの特定
- 02ネイティブとミラーの制約確認
- 03イベント購読要件の確認
- 04Webhook配信の検証と重複排除
- 05API仕様に基づくスコープ確認
- 06トークンとIDを不透明値として扱う
活用シーン
- 01APIに関する個別の疑問への仕様確認
- 02実装前のWebhook処理の点検
- 03アプリ操作に必要なスコープの特定
- 04連携移行時の動作差異の確認
インストール
コマンドをコピーしてターミナルで実行します。
npx skills add https:/ / github.com/ cursor/ plugins --skill origin-apiインストール後、Claude Code で/origin-apiを入力して読み込まれたか確認します。
詳細
Origin API
ドキュメントが正です。エンドポイント、スコープ、イベントスラッグ、ヘッダー、上限を記憶に頼って記載しないでください。このファイルとドキュメントの内容が異なる場合は、ドキュメントを優先してください。
ドキュメントは https://cursor.com/docs/api/origin/ にあります。llms.txt はインデックスで、各セクション、エンドポイント、Webhook ペイロードへのリンクを掲載しています。openapi.yaml は仕様書で、「Endpoint reference」ではその x-origin-* 拡張について説明しています。llms-full.txt にはリファレンス全体が1つのファイルにまとめられています。移動した内容は changelog に記載されています。質問が1つだけの場合は、llms.txt を起点にして、回答に必要なセクションだけを取得してください。llms-full.txt と openapi.yaml はどちらも数百キロバイトあるため、全体をコンテキストに読み込むには大きすぎます。移植の概要作成などでこれらすべてが必要な場合は、可能であれば作業中のリポジトリの外にローカル保存し、必要なセクション見出しや注釈を検索して、一致する部分だけを読んでください。operationId とセクション名を引用してください。
最初に確認するルール
- ネイティブかミラーか。 リポジトリは、Origin 上で作成されたネイティブリポジトリか、GitHub ミラーのいずれかです。ネイティブリポジトリでは、インストールにすべてのスコープとすべての書き込み権限があります。GitHub ミラーでは、
repository.pushed以外のすべてのイベントが引き続き届きますが、メタデータとコンテンツの読み取りを超える呼び出しはすべて403を返し、プルリクエストのマージやデフォルトブランチの変更はできません(「Mirrored repositories」、「Events」)。 - 登録する。 サブスクリプションなしで届くのは
installation.*イベントのみです。登録されていない場合、エラーではなく何も届きません(「Events」)。 - 検証、重複排除、応答する。 解析前に生のボディに対する署名を検証し、配信 ID で重複排除してから、
2xxを返し、その後に処理してください(「Signature verification」、「Retries」、「Automatic disable」)。Origin はダイジェストに署名しますが、Standard Webhooks はそうしないため、汎用の検証処理は失敗します。 - 仕様書に基づくスコープ。 アプリが呼び出す操作について、
x-origin-scopes.scopesの和集合をリクエストしてください(「Scopes」)。 - 不透明なトークンと ID。 ページトークンや ID を組み立てたり、解析したりしないでください(「Pagination」、「IDs」)。
インデックスからは分かりにくいセクション名が1つあります。順序が入れ替わって届いた check-run の投稿に何が起きるかは、「Ordering writes」にあります。
既存の GitHub App を移植する場合は、このプラグインの port-github-app-to-origin を使用してください。