mcpField
F
firecrawl-build-onboarding

firecrawl-build-onboarding

github.com/firecrawl開発13961.5k 回インストール6 日前に更新
リポジトリ

firecrawl-build-onboarding について

Firecrawl をアプリに組み込むためのオンボーディングスキルです。API キーの取得から SDK または REST の選択、リクエストのテストまでを扱い、新規・既存プロジェクト双方の手順と関連資料を示します。

主な機能

  1. 01API キー設定の案内
  2. 02ブラウザー認証と Stripe Projects によるキー取得
  3. 03SDK または REST の連携方式選択
  4. 04新規・既存プロジェクトの設定手順
  5. 05スモークテストの案内

活用シーン

  1. 01プロジェクトへの Firecrawl 初回導入
  2. 02`.env` への認証情報の保存
  3. 03SDK または REST 連携方式の選択
  4. 04設定後の Firecrawl リクエスト検証

インストール

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

$npx skills add https://github.com/firecrawl/skills --skill firecrawl-build-onboarding

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

同梱ファイル

SKILL.md と一緒にインストールされる参考資料やスクリプト。

references/
auth-flow.md
project-setup.md
sdk-installation.md

詳細

Firecrawl ビルドオンボーディング

Firecrawl のオンボーディングフローで、アプリケーション連携を行う場合にこのスキルを使用します。

インストール

まだインストールしていない場合は、1 つのコマンドで CLI ツール （ライブで Web を扱うため）とビルドスキル（アプリ連携用）の両方をセットアップできます。

npx -y firecrawl-cli@latest init --all --browser

これにより、Firecrawl CLI、CLI スキル、およびこれらのビルドスキルがまとめてインストールされます。また、ブラウザー認証が開始されるため、ユーザーはサインインするかアカウントを作成できます。別途 npx skills add を実行する必要はありません。

このスキルを使用する場面

  • プロジェクトで FIRECRAWL_API_KEY が必要な場合
  • ユーザーが Firecrawl を .env に設定したい場合
  • 初めてアプリに Firecrawl を追加する場合
  • 最初に使う SDK または REST の方法を選ぶ必要がある場合

ブラウザーでのサインアップ、サインイン、またはアクセスの認証が必要な場合は、このスキルの認証フローのリファレンスを使用してください。

プロジェクトですでに Stripe Projects（.projects/ ディレクトリがある、または stripe projects status が成功する）を使用している場合は、ブラウザーフローの代わりにそこからキーを取得できます。

stripe projects add firecrawl/api --name firecrawl
stripe projects env --pull

--name firecrawl を指定すると、キーが FIRECRAWL_API_KEY に設定されます。指定しない場合、CLI は FIRECRAWL_API_API_KEY に書き込みますが、SDK はこの変数を読み取りません。CLI が同時に書き込む FIRECRAWL_API_BASE_URL は無視してください。SDK が読み取るのは FIRECRAWL_API_URL で、セルフホスト型のデプロイの場合に限られるため、ホスト型アカウントでは設定しないでください。有料プランにするかどうかはユーザー自身が判断してください。stripe projects upgrade firecrawl を実行すると、ユーザーのカードに請求されます。カタログとトラブルシューティングについては、ドキュメントのページを参照してください。

クイックスタート

ユーザーがすでに API キーを持っている場合は、.env に設定します。

FIRECRAWL_API_KEY=fc-...

プロジェクトがセルフホスト型の場合は、次も設定します。

FIRECRAWL_API_URL=https://your-firecrawl-instance.example.com

次に、該当する連携方法を選びます。

  • 新規プロジェクト -> 対象のスタックを選び、SDK をインストールして、最初の Firecrawl 呼び出しを追加し、スモークテストを実行します
  • 既存プロジェクト -> まずリポジトリを確認し、プロジェクトですでにサードパーティ API や環境変数を扱っている箇所に Firecrawl を連携します

必要な作業は何ですか？

作業リファレンス
ブラウザー認証フローを実行して FIRECRAWL_API_KEY を保存するreferences/auth-flow.md
Stripe Projects を通じてキーをプロビジョニングするdocs.firecrawl.dev/integrations/stripe-projects
適切な SDK をインストールするreferences/sdk-installation.md
認証情報を .env またはプロジェクト設定に追加するreferences/project-setup.md
セットアップ後に適切なエンドポイントを選ぶfirecrawl-build
この作業中にライブ Web ツールが必要な場合同じコマンドで CLI スキルがすでにインストールされています
既知の URL から実装を開始するfirecrawl-build-scrape
クエリから実装を開始するfirecrawl-build-search

ドキュメント（信頼できる情報源）

SDK の使用方法、スキーマ、例については、プロジェクトで使う言語の信頼できる情報源となるページを参照してください。

セットアップ後

キーが設定されたら：

  1. 新規プロジェクトか、既存のコードベースかを判断します
  2. 製品で Firecrawl に何を実行させるかを確認します
  3. その動作に合った、最も範囲の狭いエンドポイントを選びます
  4. コードを書く前に、プロジェクトで使用する言語の一次情報ページを読みます
  5. SDK または REST 呼び出しをコードに追加します
  6. Firecrawl への実際のリクエストが 1 件成功することを確認するスモークテストを実行します
  7. 実装のガイダンスには、このリポジトリ内のエンドポイント固有のスキルを使用します
  8. 現在のタスクでライブのウェブツールも必要な場合は、CLI スキルがすでにインストールされています — firecrawl/cli を使用します

コメント

Markdown 対応