mcpField
C
convex-agent

convex-agent

github.com/convexエージェントワークフロー6937.0k 回インストール1 日前に更新
リポジトリ

convex-agent について

`@convex-dev/agent`でアプリ内AIエージェントとRAGバックエンドを構築するスキルです。永続スレッド、メッセージ履歴、ツール呼び出し、ベクトル検索を扱い、モデル呼び出しにはConvex AI Gatewayを既定で使用します。

主な機能

  1. 01スレッドとメッセージ履歴を永続化
  2. 02エージェントのツールと指示を定義
  3. 03メッセージをストリーミング
  4. 04ベクトル検索とRAGを追加
  5. 05Convex AI Gateway経由でモデルを呼び出し
  6. 06プロバイダーキーをConvex envに保持

活用シーン

  1. 01会話を永続化するアプリ内エージェントを構築
  2. 02エージェントのツールにドキュメント検索を追加
  3. 03ゲートウェイ利用時のモデルプロバイダーキー管理を回避

インストール

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

$npx skills add https://github.com/convex/agent-skills --skill convex-agent

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

詳細

AI エージェント/RAG バックエンドを追加する

@convex-dev/agent をインストールすると、永続化可能なスレッド、メッセージ履歴、ツール呼び出し、ベクトル検索/RAG を利用できます。アプリ内 AI エージェントのバックエンドとして使用できます。デフォルトでは Convex AI Gateway を通じてモデルを呼び出します。プロバイダーの認証情報は Convex が保持するため、LLM キーを取得、保存、ローテーションする必要はありません。

ワークフロー

  1. @convex-dev/agent と @convex-dev/ai-sdk-provider をインストールし、エージェントコンポーネントを convex.config.ts に追加します。
  2. languageModel: convexGateway("provider/model") を使用してエージェント(ツール、指示)を定義します。API キーは不要です(Convex Cloud のデプロイで Convex 1.45 以降、有料プランが必要です)。
  3. スレッドを作成してメッセージをストリーミングし、履歴を Convex に保存します。
  4. RAG を使用する場合は、ドキュメントをベクトルインデックスに埋め込み、ツール内で検索します。Gateway はまだ埋め込みを提供していないため、env マイクロパワーを使って埋め込みプロバイダーのキーを保存します。
  5. Gateway を利用できない場合(無料プラン、セルフホスト、ローカルバックエンド)に限り、env マイクロパワーを使って保存したキーでプロバイダー SDK を呼び出します。

ルール

  • モデル呼び出しには Convex AI Gateway(@convex-dev/ai-sdk-provider の convexGateway)をデフォルトで使用します。Gateway を利用できない場合(無料プラン、セルフホスト、ローカルバックエンド)に限り、Convex env に保存したプロバイダーキーにフォールバックします。
  • プロバイダーの API キーをクライアント側に公開しないでください。キーが必要な場合(埋め込み、Gateway のフォールバック)は、env マイクロパワーを使って Convex env に保存してください。
  • モデル呼び出しはアクションで実行します(SDK が必要とする場合は 'use node' を指定します)。
  • 永続性とリアクティブ性を確保するため、スレッド/メッセージを Convex に保存します。

コメント