copilotkit

CopilotKit

CopilotKit の API は変更されます。スキルファイルに書き留めた内容はすぐに古くなり始めるため、このスキルでは意図的に API の詳細をほとんど記載していません。現在の情報がどこにあるのか、どう確認すればよいのかを説明します。

コードを書く前に確認してください。 ドキュメントのほうが使いやすいからではなく、ソースから再生成されるものであり、記憶に頼るものではないからです。

ドキュメントを読む

最新のドキュメントを読む方法は 2 つあります。このセッションでどちらを利用できるか確認してください。

MCP サーバーを使わない場合：Markdown ページを取得する

この方法は常に使えます。URL を取得する手段だけあれば十分です。

• 任意のドキュメントページを Markdown で取得する。 ページパスに .md を追加します： https://docs.copilotkit.ai/<path>.md。たとえば、 https://docs.copilotkit.ai/quickstart.md や https://docs.copilotkit.ai/backend/copilot-runtime.md です。レスポンスは text/markdown です。存在しないパスは、本文が Not found の 404 を返します。
• パスを探す。 まず https://docs.copilotkit.ai/llms.txt を確認します。主要ページへのリンクをまとめた、短く厳選されたインデックスです。掲載されていないページについては、すべてのページ URL が記載された https://docs.copilotkit.ai/sitemap.xml を確認してください。どちらのインデックスにも HTML ページの URL が記載されています。取得する前に URL に .md を追加してください。サイトのルートには .md 形式がありません。 llms-full.txt を一度に取得しないでください。すべてのページが含まれており、サイズが数メガバイトあります。
• このスキル内のリンク。 quickstart のようなリンクは、ドキュメントのパスです。 https://docs.copilotkit.ai/quickstart.md として取得してください。
• ライブラリのソース。 インストール済みパッケージ node_modules/@copilotkit/、または https://github.com/CopilotKit/CopilotKit の packages/ 以下にあるソースを読んでください。
• AG-UI プロトコル。 このプロトコルには https://docs.ag-ui.com に独自のドキュメントがあります。インデックスは https://docs.ag-ui.com/llms.txt で、各ページには .md を付けて取得できます。

MCP サーバーの使用: 検索ツール

CopilotKit Claude Code プラグインは、.mcp.json で copilotkit-docs という MCP サーバーも宣言しています。このサーバーが読み込まれると、4 つの別々のコーパスを対象とした検索ツールが追加されます。 これはより速く検索する方法ですが、必須ではありません。これらのツールがこのセッションにない場合は、上記の Markdown ページを使用してください。

ツール	コーパス	用途
search-docs	docs.copilotkit.ai	使い方、設定、ガイド、クイックスタート、生成された API リファレンス
search-code	CopilotKit ライブラリのソース	実装方法と正確なシグネチャ。ライブラリパッケージのみで、サンプルやショーケースは含まない
search-ag-ui-docs	AG-UI プロトコルのドキュメント	プロトコル自体: イベントタイプ、トランスポート、SDK
search-ag-ui-code	AG-UI プロトコル SDK のソース	プロトコルの実装詳細
explore-docs / explore-code	どちらのツリーでも	何を検索すればよいかわからないときに、構造を閲覧する

CopilotKit に関する質問は最初の 2 つに、AG-UI プロトコルに関する質問は後の 2 つに向けてください。 これらは別のリポジトリであり、search-docs では見つからません。

これらはセマンティック検索です。 異なる言葉を使った短いクエリを複数回行う方が、1 つの長いクエリより効果的です。結果が的外れな場合は、クエリを言い換えてください。検索範囲を広げないでください。ページは適切に見えても必要な用語が含まれていない場合は、その旨を伝えてください。タイトルだけで推論しないでください。

プラグイン以外で検索ツールを使いたいユーザーは、自分でサーバーを追加できます。エンドポイントは https://mcp.copilotkit.ai/mcp（streamable HTTP）と https://mcp.copilotkit.ai/sse（SSE）です。パスは省略しないでください。ホストのみでは 404 が返されます。 各コーディングツールの手順は Build with agents にあります。セットアップの手順として、自分でサーバーを追加しないでください。Markdown ページにも同じ内容があります。

回答の場所

検索や取得の出発点として知っておくと便利な情報です。各リンクはドキュメントのパスです:

• はじめに — クイックスタート、および CLI を使う場合は CLI
• フロントエンド — フロントエンドツール、human-in-the-loop、プリビルドコンポーネント、スタイリング、添付ファイル、音声
• ランタイム — ランタイム、HTTP エンドポイント、ランナー、ファクトリーモード、サーバーアダプター、認証
• エージェントフレームワーク — フレームワークごとに 1 つのクイックスタートがあり、https://docs.copilotkit.ai/<framework>/quickstart.md にあります。フレームワークのスラッグは llms.txt にあり、例として langgraph-python、mastra、crewai-crews などがあります。
• Intelligence — 概要 およびその配下のページ
• 動作しない場合 — よくある問題、エラーリファレンス、そしてアプリが実際に報告したコードについては、生成された CopilotKitCoreErrorCode
• プロトコル — AG-UI、およびプロトコル自体については AG-UI のドキュメント

デバッグを始める前に

まず CLI の配線チェックを実行してください。1つのコマンドで最大11項目を確認でき、ほとんどの場合、プロジェクトを読むよりも速く済みます。アプリに合った形式を選んでください。

• Intelligence なし（ランタイムの構築時に CopilotKitIntelligence を生成する処理がなく、.copilotkit/project.json もない場合）： npx copilotkit@latest verify --expect-runtime oss --round-trip --agent <id> --json --via skill:copilotkit
• それ以外： npx copilotkit@latest verify --json --via skill:copilotkit

--via skill:copilotkit は、この呼び出しがこのスキルから行われたことを CopilotKit のテレメトリに伝えるだけです。 CLI が Unknown option '--via' と報告する場合、npx が古いキャッシュ済みバージョンを実行しています。フラグを外してコマンドを再実行してください。

verify を通すことだけを目的に、login や project select を実行しないでください。これらのコマンドはホステッド版 Intelligence をセットアップするものであり、オープンソースのアプリの問題は解決しません。copilotkit-cli スキルを参照してください。

バージョンは2つあります

現在のバージョンは v2 です。/v2 サブパスからインポートしてください。例：@copilotkit/react-core/v2、@copilotkit/runtime/v2。パッケージのルートは非推奨の v1 インターフェースですが、引き続き解決されるため、両方を混在させてもインポート時にはエラーにならず、後になってランタイムの不一致として表面化します。プロジェクトがどのサブパスをインポートしているかを、ほかの情報を信頼する前に確認してください。v1 は非推奨ですが、引き続きサポートされています。移行ガイドでは、v1 からの移行方法を説明しています。