mcpField
C
convex-agent

convex-agent

github.com/get-convex开发6931.2k 次安装1 天前更新
代码仓库

关于 convex-agent

为 Convex 应用添加 AI Agent 或 RAG 后端的技能,使用 @convex-dev/agent 管理持久化对话、消息历史、工具调用和向量检索。它默认通过 Convex AI Gateway 调用模型,并将密钥保存在 Convex 环境中。

主要功能

  1. 01集成 @convex-dev/agent
  2. 02持久化对话与消息历史
  3. 03配置工具调用
  4. 04构建向量检索与 RAG
  5. 05通过 Convex AI Gateway 调用模型

适用场景

  1. 01为应用添加 AI Agent 后端
  2. 02持久化 Agent 对话记录
  3. 03基于文档实现 RAG 检索

安装

复制下面的命令,在终端中运行。

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

安装后在 Claude Code 中输入/convex-agent确认已加载。

详细介绍

添加 AI Agent / RAG 后端

安装 @convex-dev/agent,以支持持久化线程、消息历史记录、工具调用和向量搜索/RAG——作为应用内 AI Agent 的后端。默认通过 Convex AI Gateway 调用模型:凭据由 Convex 持有,因此无需获取、存储或轮换 LLM 密钥。

工作流

  1. 安装 @convex-dev/agent + @convex-dev/ai-sdk-provider;将 agent 组件添加到 convex.config.ts。
  2. 使用 languageModel: convexGateway("provider/model") 定义 Agent(工具、指令)——无需 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 中。
  • 在 actions 中运行模型调用(如果 SDK 需要,请使用 'use node')。
  • 在 Convex 中持久化线程/消息,以确保持久性和响应性。

评论

支持 Markdown