Signal Foundry
ドキュメント
サポート 戻る
ドキュメントユースケースAPI リファレンスリリースノート

概要

Agent が迷わず使える順に整理しています。

はじめに
Claude Code / Codex で始めるドキュメントマップsf CLI をインストールデータ・API・CLIの現況クイックスタートCLI 接続設定会社IDの見方初日の進め方Data Provenance
認証請求認証設定利用プランCLI
CLI 概要CLI 認証基本コマンド会社検索観測データ検索会社・観測・開示開示の表示・比較リスト・調査・クレジットヘルプとエラーコマンドとフラグCLI 更新
APIキーのライフサイクル利用量の計測提供中の機能
会社検索とプロフィール観測データ検索チームワークスペース会社の観測データ開示と比較APIキー管理UIリストワークスペース外部調査とクレジットSkills / CLI / API
Credit Schedule利用状況の見方APIキー認証アカウントスコープは通常不要レート制限とエラートラブルシュート
会社が見つからないとき認証・接続・制限エラー低ヒット検索の見直し方プレビューURLの注意credit と maxCredits の失敗estimate と materialize の失敗
概要

Claude Code / Codex で始める

ユーザーがこの docs を Claude Code / Codex にそのまま渡し、install 済み CLI から auth、first task まで進めるための実務ガイドです。

このページの内容7項目
先に人間がやることSkills / CLI / API の役割Claude にそのまま渡せる初回プロンプトClaude に期待する最初の確認失敗時に Claude が見るべきもの保存と review まで任せる場合次に渡すページ

Signal Foundry は、ブラウザ上の操作よりも CLI + JSON + 必要なときだけ API で使う方が自然です。Claude Code / Codex に渡すときも、同じ順番を崩さない方が安定します。

agent が docs URL だけを渡されて読んでいる場合も、最初に package availability を確認します。npm view @signal-foundry/cli version が version を返すまでは、public npm install を前提に進めません。

このページの目的は、ユーザーが agent に次の 3 つを任せられる状態にすることです。

  • 接続設定
  • skill routing
  • estimate -> candidates -> materialize -> enrich -> export の credit workspace 疎通確認
  • 必要に応じた company_id 解決
  • profile / observations / filings / compare の 1 社調査

先に人間がやること

  1. sf CLI を使える状態にする
  2. API キーを発行する
  3. sf auth setup --base-url https://signal-foundry.app を済ませる
  4. sf agent install --target codex または sf agent install --target claude を済ませる

最初の確認:

npm view @signal-foundry/cli version

version が返る場合の install 導線:

npm install -g @signal-foundry/cli
sf version

one-shot の確認:

npx -y @signal-foundry/cli@latest version

最低限の確認は次です。

sf auth show --json
sf companies search 7203 --json

未接続なら、API キーは chat ではなく terminal 側で保存します。

sf auth setup --base-url https://signal-foundry.app
sf auth show --json

すでに API キー設定画面を開いている場合は --no-open を付けてください。

sf auth setup --base-url https://signal-foundry.app --no-open

Codex / Claude Code で自然文から進めるなら、skill bundle も 1 回だけ入れます。

sf agent install --target codex
sf agent install --target claude

配置後は agent を再起動してください。

すでに同名 skill がある場合は --force を使います。

Skills / CLI / API の役割

  • skills: 自然文の job を companies observations search filings lists のどこから始めるか決める
  • CLI: 再実行しやすいコマンド、--help、--json、error.hint を返す
  • API: 直接統合したいときの contract を提供する

agent handoff の中心は skills -> CLI -> API です。最初から API を直接組み立てる必要はありません。sf agent install は、この skills の入口を Codex / Claude Code 側へ置くための 1 回限りのセットアップです。

Claude にそのまま渡せる初回プロンプト

Signal Foundry を使って、最初の company-list credit workspace loop まで進めてください。

前提:
- base URL は `https://signal-foundry.app` です
- API key はすでに `sf auth setup --base-url https://signal-foundry.app` で保存済みです

最初に次を順番に実行してください:
1. `sf auth show --json`
2. `sf list estimate "上場企業のうち、売上100億以上" --json`
3. 返ってきた `estimate_id` で `sf list candidates --from-estimate <estimateId> --json`
4. 保存するなら `sf list materialize --from-estimate <estimateId> --name "売上100億以上の上場企業" --execute --max-credits <estimatedCredits> --json`
5. 追加情報を足すなら `sf list enrich <listId> --source website --estimate --json`
6. 実行するなら `sf list enrich <listId> --source website --execute --max-credits <estimatedMaxCredits> --json`
7. 最後に `sf list export <listId> --format csv --output ./exports/listed-revenue-10b.csv --json`

ルール:
- `materialize` と `enrich` は必ず estimate 後に `--execute --max-credits` で実行してください
- candidate preview は export しないでください
- 1 社調査で `profile` や `filings` を呼ぶ前に、必ず `companies search` で `company_id` を解決してください
- すべて `--json` で実行してください
- API キーを Claude Code のチャットに貼り付けないでください
- 失敗時は `error.code` `error.hint` `error.suggested_next_commands` を見て、そのまま次のコマンドを提案してください
- `list plan` の `plan.confidence` が low、または `plan.weak_conditions` / `plan.unsupported_conditions` がある場合は、無理に保存せず、何が未対応かを要約して代替条件を提案してください。`list estimate` 後は `resolved_definition.warnings` も確認します
- コマンドごとに「何を確認したか」「次に何をするか」を短く要約してください
- 必要なら `sf --help` と `sf <surface> --help` を先に見てから進めてください

Codex に docs ごと渡す場合も同じです。このページか Quick Start の URL を添えて、「この docs に従って進めて」と渡せば十分です。

Claude に期待する最初の確認

  • auth show で effectiveBaseUrl と effectiveApiKeyPreview が見える
  • list estimate で estimate_id と credit 見積もりが返る
  • list candidates で薄い candidate preview が返る
  • list materialize は --execute --max-credits 明示時だけ保存する
  • list enrich は found のみ課金される
  • list export は saved List から無料で CSV を書き出す

失敗時に Claude が見るべきもの

Signal Foundry CLI は、--help と構造化エラーを agent が読みやすい形で返します。

まず見るもの:

  • sf --help
  • sf companies search --help
  • sf company profile --help
  • sf filing compare --help

失敗時に見る JSON:

  • error.code
  • error.exit_code
  • error.hint
  • error.suggested_next_commands
  • error.retryable

company_not_found のようなエラーでは、error.suggested_next_commands に次の一手が入ります。人間が手で考える前に、まずその候補を試す前提で進めてください。

保存と review まで任せる場合

候補を残して明日見直したい job なら、agent に次も足してください。

保存が必要なら `sf list plan` で条件を確認してから `sf list estimate` `sf list candidates` `sf list materialize --execute --max-credits` まで進め、追加情報が必要なら `sf list enrich --source website --estimate` の後に `--execute --max-credits` まで進めてください。CSV 起点なら `sf source import -> inspect -> map -> resolve -> sf list create --from-source` を使います。

list preview / publish / refresh / diff は saved List の current public surface です。新しい会社リスト作成は estimate -> candidates -> materialize を優先します。delivery handoff は advanced API surface として扱い、approval workflow と full monitor はまだ deferred 側です。

次に渡すページ

  • 接続から最初の成功までを人間も追いたい場合: Quick Start
  • docs を Codex にそのまま投げたい場合: Codex に docs を渡して進める
  • Skills / CLI / API の役割を先に見せたい場合: Skills, CLI, and API
  • company_id の意味を説明したい場合: Company ID Surface Map
  • 初日に何を順番に試すかまで定義したい場合: First Day Playbook

このページの内容

先に人間がやることSkills / CLI / API の役割Claude にそのまま渡せる初回プロンプトClaude に期待する最初の確認失敗時に Claude が見るべきもの保存と review まで任せる場合次に渡すページ