mcpField
I
inngest-api

inngest-api

github.com/inngestクラウド・DevOps29800 回インストール4 週間前に更新
リポジトリ

inngest-api について

inngest-api は、Inngest を扱う開発者やエージェント向けに、REST API v2 の資料参照と HTTP 操作を案内するスキルです。アカウント、環境、実行、トレース、Insights の API を扱い、一般的な作業では Inngest CLI や MCP を先に使うよう示します。

主な機能

  1. 01REST API v2 の資料とスキーマの参照
  2. 02アカウント、環境、キー、Webhook の操作
  3. 03アプリ、関数実行、トレースの照会
  4. 04Insights クエリの実行
  5. 05認証と変更時の安全ルール

活用シーン

  1. 01関数実行やイベント実行のトレース確認
  2. 02CLI にないエンドポイントの HTTP 呼び出し
  3. 03エンドポイントのリクエストとレスポンス構造の確認
  4. 04変更前に対象環境を検証

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/inngest/inngest-skills --skill inngest-api

インストール後、Claude Code で/inngest-apiを入力して読み込まれたか確認します。

同梱ファイルreferences/rest-api-v2.md

詳細

Inngest REST API v2

接続された MCP ツールを使った Cloud 操作には、まず inngest-cloud を使用してください。 このスキルは、明示的なターミナル/HTTP 作業、または MCP に欠けている機能のために取っておいてください。OAuth MCP でタスクを完了できる場合、API キーを要求しないでください。

このスキルは、生の REST API v2 の作業と API リファレンスの参照に使用します。タスクが npx inngest-cli@latest api で完了できる場合は、代わりに inngest-api-cli を使用してください。CLI はターゲット/認証フラグとエンドポイントコマンドの配線を処理するため、エージェントにとってより安全です。

まず CLI を優先する

次の用途には inngest-api-cli を使用してください:

  • 実行 ID またはイベント ID からの実行とトレースのデバッグ。
  • アカウント、環境、キー、Webhook、アプリ同期、関数呼び出しの確認。
  • Insights のテーブル/スキーマ/クエリのワークフロー。
  • ローカル開発サーバーまたは Cloud の運用チェック。

生の REST API v2 は次の場合にのみ使用してください:

  • CLI が必要なエンドポイントを公開していない。
  • ユーザーが HTTP、curl、fetch、OpenAPI、または API ドキュメントを明示的に求めている。
  • 何をするかを決める前にリクエスト/レスポンスのスキーマを確認する必要がある。

ドキュメントの参照

正確さが重要な場合は、推測せずに最新のドキュメントを取得してください:

  • API の概要: https://api-docs.inngest.com/
  • 認証: https://api-docs.inngest.com/authentication
  • LLM インデックス: https://api-docs.inngest.com/llms.txt
  • OpenAPI v2 仕様: https://api-docs.inngest.com/api-specs/v2.json
  • Markdown ページのパターン: ドキュメントの URL に .md を追加します。たとえば https://api-docs.inngest.com/v2/runs/GetFunctionTrace.md
  • エンドポイントのリクエスト/レスポンススキーマ: references/rest-api-v2.md

Markdown ページがエラーを返す場合、または生成されたリファレンスの詳細が欠けている場合は、メソッド、パス、パラメーター、リクエストボディ、スキーマについて OpenAPI 仕様を使用してください。

ベース URL

  • Cloud v2: https://api.inngest.com/v2
  • ローカル開発サーバー v2: http://localhost:8288/api/v2
  • API ドキュメントには、開発サーバーはローカルサーバーのオリジン経由でもアクセスできると記載されています。ローカルリクエストを行う前に、実際の開発サーバーのポートを確認してください。

認証

REST API は Bearer トークン認証を使用します。

  • CI、スクリプト、ツール、エージェントからのリクエストには INNGEST_API_KEY を優先してください。
  • 署名キーは主に Inngest と通信するアプリ用です。利用可能で適切な資格情報である場合にのみ、API リクエストに使用してください。
  • API キーは v2 エンドポイント専用です。
  • デフォルトの本番環境以外で操作する場合は、X-Inngest-Env を含めるか、環境スコープの API キーを使用してください。
  • API キー、イベントキー、署名キー、Webhook URL、復号されたシークレットを貼り付けたり、出力したり、コミットしたり、ログに記録したりしないでください。

例:

curl -fsSL \
  -H "Authorization: Bearer $INNGEST_API_KEY" \
  -H "X-Inngest-Env: $INNGEST_ENV" \
  https://api.inngest.com/v2/account

エンドポイントの検出

OpenAPI 仕様を信頼できる情報源として使用してください:

curl -fsSL https://api-docs.inngest.com/api-specs/v2.json

現在の v2 の領域には、アカウント、環境、キー、Webhook、アプリ、関数呼び出し、イベント実行の検索、関数実行、トレース、Insights、パートナー API が含まれます。エンドポイントの範囲は変わる可能性があるため、生のリクエストを書く前に仕様を確認してください。

パートナーアカウントのエンドポイントなど、API 専用またはアクセス制限のあるエンドポイントについては、呼び出しを試みる前に、ユーザーが必要なアクセス権を持っていることを確認してください。

リクエストのルール

  • メソッド、パス、クエリパラメーター、ヘッダー、ボディは OpenAPI から導き出してください。
  • 文書化されていないリクエストフィールドを考案しないでください。
  • レスポンスから判断を下す前に、構造化された JSON パースを使用してください。
  • 複雑な JSON には、シェルエスケープされたワンライナーではなく、ボディファイルまたはヒアドキュメントを使用してください。
  • page.hasMore が true で完全な結果が必要な場合は、ページネーションカーソルを追加してください。
  • エラーが存在しない限り、リストレスポンスで data が欠けている場合は空のリストとして扱ってください。

変更の安全性

書き込みの前に読み取りを行ってください。ユーザーの指示ですでにすべてが明示されていない限り、生の HTTP 変更の前に、対象のアカウント、環境、リソース、および意図を確認してください。

次のカテゴリは変更または副作用を伴うものとして扱ってください:

  • 環境の作成またはパッチ適用。
  • Webhook の作成。
  • アプリの同期。
  • 関数の呼び出し。
  • パートナーアカウントの作成。
  • 高コストまたは負荷の高い可能性のある広範な Insights クエリ。

出力の取り扱い

  • ID、名前、ステータス、ページネーション、および対応が必要なエラーを要約します。
  • トークンの値、Webhook URL、機密性の高いペイロードフィールド、および復号された シークレットはマスクします。
  • ユーザーが求めない限り、大量の生トレース、OpenAPI の断片全体、またはレスポンス ボディ全体を貼り付けないでください。
  • 認証に失敗した場合は、まず環境に認証情報が存在することを確認します。 そのうえで、INNGEST_API_KEY をチャットに貼り付けずに、ユーザーに提供または ローテーションするよう依頼してください。

コメント

Markdown 対応