reading-livekit-docs

LiveKit ドキュメントの読み方

LiveKit の SDK はモデルの学習データよりも速く変化するため、LiveKit の API、CLI フラグ、デフォルト値について覚えていることはすべて推測にすぎません。誤った推測は時間の無駄になります。フラグを間違えれば実行を無駄にし、シグネチャを間違えればビルドを無駄にします。

述べる内容やコードに含める LiveKit 固有の情報は、すべてこのセッション中に調べたものにしてください。 自信がある情報や、ほかのリポジトリで見たパターンも含みます。

優先順位に従った参照先

1. LiveKit Docs MCP サーバー。 セッションでツールを利用できる場合は、それを使ってください。CLI が使うのと同じ情報源で、より手軽です。

2. lk docs。 LiveKit CLI がインストールされていればどこでも利用でき、MCP のセットアップは不要です。MCP ツールがない場合はこれを使い、ユーザーに何かのインストールを先に頼むのは避けてください。ドキュメントの検索やページの取得、LiveKit のリポジトリ全体にわたるコード検索、SDK の最近の変更履歴の表示、料金の確認、フィードバックの送信ができます。まず次を実行します。

lk docs --help
lk docs search "agent simulations"

検索で適切なページが見つかったら、そのページを取得します。読む代わりに解析したい場合は、機械可読な出力を利用できます。

3. docs.livekit.io を対象にしたウェブ検索。 上記のどちらも利用できない場合に限ります。この方法に切り替えたことをユーザーに伝え、生成したコードには未検証のマークを付けてください。

調査方法

• 読む前に検索します。 検索結果にはページごとの抜粋が表示されるため、通常はそれだけで適切なページを選べます。必要なページが分かってから全文を取得してください。そうしないと、使わないページでコンテキストウィンドウが埋まってしまいます。
• 方法はコード検索で、内容はドキュメントで確認します。 ドキュメントからは、パラメーターが存在することが分かります。LiveKit 独自のサンプルからは、その呼び出し方が分かります。ドキュメントのページと動作するサンプルの内容が異なる場合は、サンプルに従い、食い違いについて説明してください。
• バージョンに関する質問には変更履歴を使います。 「X はもう使えますか」「Y はいつ変わりましたか」「この引数が存在しないのはなぜですか」といった疑問には、検索ではなく変更履歴で答えられます。
• 使用中のバージョンを確認します。 動作する内容は、インストール済みの SDK と CLI によって決まります。ドキュメントに記載されている機能が、インストール済みのバージョンには存在しないこともあります。CLI コマンドを使う場合は、インストール済みのバイナリで実行した --help の内容を、ほかのすべての情報源より優先してください。

調査結果の報告

• 判断の根拠としたページを引用し、ユーザーが確認できるようにしてください。
• 確認できなかったことは、その旨を伝えてください。「このシグネチャはドキュメントと照合して確認できませんでした」と伝えることは、ユーザーの役に立ちます。黙って推測するのは避けてください。
• 未検証のコードにはマークを付けてください。検索せずに LiveKit のコードを書く必要があった場合は、呼び出し箇所に未検証であることを示すコメントを追加し、返信でもその旨を伝えてください。
• サンプルを完成しているように見せるために、フラグやパラメーターを捏造しないでください。もっともらしく捏造するより、注記を添えた未完成のサンプルのほうが適切です。

ドキュメントに誤りがある場合

ページの内容が SDK のソースや CLI の --help と矛盾することがあります。その場合は、次のように対応します。

• 実際に動作する内容に従います。 --help、インストール済み SDK のソース、動作するサンプルは、説明文のページより優先されます。どの情報に従ったのか、その理由とともにユーザーに伝えてください。
• ドキュメントのフィードバックコマンドで報告し、報告したことをユーザーに伝えて、次の人が同じ問題に遭遇しないようにしてください。

ドキュメントサーバーが CLI より少し先行していると、lk docs がバージョンのずれについて警告することがあります。これはよくあることで、検索結果は引き続き有効です。lk の更新を提案し、そのまま作業を進めてください。

関連スキル

• エージェントの構築：building-livekit-agents
• 開発中のライブテスト：debugging-livekit-agents
• ユニットテスト：testing-livekit-agents
• シミュレーション：writing-livekit-scenarios、running-livekit-simulations