コンテンツにスキップ

未翻訳のページは英語で開き、英語と表示されます。

このページは英語の原文の機械翻訳です。内容は英語の原文が優先されます。 Machine-translated from the English page, which is authoritative.

リファレンス

リファレンスのページでは、何が存在し、各オプションが何を意味するかを説明します。設計の背景にある理由は、コンセプトとアーキテクチャに記載しています。手順については、ガイドと運用のセクションを参照してください。

コードから生成されるページ

これらのページ、またはページ内の表は、それを定義しているソースから生成されます。各ジェネレーターには --check モードがあり、make lint がこれを実行するため、コードとずれたページは CI で失敗します。ソースを編集して再生成してください。生成された表を手で編集してはいけません。

ページ 掲載内容 ソース ジェネレーター
設定 すべての LOOM_* 設定について、デフォルト値と意味を領域別に掲載します。 server/settings/ 内のフィールド上のコメント python scripts/codegen/settings_reference.py
オペレーション すべてのオペレーションをグループ別に、ロール、種別、MCP の all 一覧、監査フラグとともに掲載します。あわせてレジストリの仕組みも説明します。 server.operations.registry.ALL_OPERATIONS python scripts/codegen/docs_reference.py
ワーカー すべてのバックグラウンドワーカーについて、スイッチ、デフォルト値、実行間隔を掲載します。あわせてスーパーバイザーがワーカーを実行する仕組みも説明します。 server/workers/registry.py(_WORKERS) python scripts/codegen/docs_reference.py
CLI すべての loom コマンドとサブコマンドをフラグとともに掲載します。あわせて CLI の実行場所とよく使うコマンドも説明します。 loom パーサーツリー(tests/unit/snapshots/cli_tree.json) python scripts/codegen/docs_reference.py
エラー サーバーが返すすべてのエラーコードを掲載します。あわせてエンベロープ、リトライのルール、主なコードの対処法も説明します。 server/core/errors.py と server/ 配下のすべての "code" リテラル python scripts/codegen/docs_reference.py
ステータス 各オペレーショングループのうち安定版の数、各実験的オペレーション、および false でロードされるすべてのブール設定を掲載します。 レジストリ内のオペレーションの maturity と server/settings/catalog.py のブールフィールド python scripts/codegen/docs_reference.py
スキーマ すべてのテーブルとマテリアライズドビューを、エンジン、キー、TTL、インデックスとともに掲載します。あわせてカラムの規約も説明します。 schemas/schema.sql python scripts/codegen/docs_reference.py

docs_reference.py のページで生成されるのは、<!-- BEGIN GENERATED: … --> マーカーと <!-- END GENERATED: … --> マーカーの間の領域だけです。その周囲の文章は手書きです。SDK パッケージ内のオペレーション表(sdk/python/loom/ops.py、sdk/typescript/src/generated/ops.ts)も、scripts/codegen/sdk_py_gen.py と sdk_ts_gen.py によって生成されます。詳しくはコード生成を参照してください。

手書きのページ

ページ 内容
HTTP API すべてのルート(op、ディスカバリ、ヘルス、ストリーム、サインイン、OAuth、ダッシュボード、オペレーター)、ゲートの順序、ヘッダー、未知のフィールド、冪等性、ページネーション、レート制限。
MCP /mcp エンドポイント、認証と OAuth、セッションと ID、ツール一覧とツールセット、結果、エラー、アクションスキーマのエクスポート。
Python SDK インストール、クライアントの構築、op の呼び出し、型付きの形状、セッションとツール、フレームワークアダプター、エラー、リトライ。
TypeScript SDK インストール、クライアントとオプション、型付き op、セッションとツール、ページネーション、Strands アダプター、エラー、リトライ。
環境変数 設定モデルの外で読み込まれる変数:プロバイダーキー、イメージ、compose ファイル、CLI、SDK、オペレータースクリプト。
SQL サーフェス テナントのデータに対する読み取り専用の sql_v1_* ビュー:カラム、互換性ルール、非公開にする内容、鮮度、loom sql-access。
エクストラクター契約 エクストラクターサービスが提供する HTTP 契約のバージョン 1:機能、抽出、エラーコード、アーティファクトのフィールドとルール。

手書きのページには、ツリー内に存在するものだけを記載し、説明対象のソースへのリンクを付けています。

どのページが答えるか

  • 「この op の名前は何か、誰が呼び出せるのか。」→ 操作。
  • 「この設定は何をするのか。」→ 設定。
  • 「このエラーコードは何を意味し、再試行すべきか。」→ エラー。
  • 「この op は安定版か実験的か、この設定はデフォルトで有効か。」→ ステータス。
  • 「どのヘッダー、どのルートか、ページングはどうするのか。」→ HTTP API。
  • 「MCP クライアントにツールが表示されないのはなぜか。」→ MCP。
  • 「このワーカーは動作しているか、有効にするにはどうするのか。」→ ワーカー。
  • 「次回のデプロイでクライアントは壊れないか。」→ 不明なフィールドと削除されたフィールドおよびデプロイメントが提供する内容の確認。
  • 「このテーブルには何が入っているか。」→ スキーマ。
  • 「loom <command> は何を受け取るか。」→ CLI。