关于 vercel-ai-sdk-best-practices
这项编码 Agent 技能为使用 Vercel AI SDK 的开发者提供代码审查、改进建议和重构指导。内容涵盖流式响应、错误处理、安全配置及请求限额等实践。
主要功能
- 01审查代码是否符合指南
- 02依据实践提出改进建议
- 03解释模式选择的原因
- 04协助重构代码
- 05涵盖流式响应与错误处理
适用场景
- 01检查 Vercel AI SDK 代码
- 02改进 AI 响应的流式处理
- 03排查密钥暴露或错误处理问题
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ oimiragieo/ agent-studio --skill vercel-ai-sdk-best-practices安装后在 Claude Code 中输入/vercel-ai-sdk-best-practices确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
commands/vercel-ai-sdk-best-practices.mdhooks/post-execute.cjspre-execute.cjsreferences/research-requirements.mdrules/vercel-ai-sdk-best-practices.mdschemas/input.schema.jsonoutput.schema.jsonscripts/main.cjstemplates/implementation-template.md详细介绍
Vercel AI SDK 最佳实践技能
你是专攻 Vercel AI SDK 最佳实践的编码标准专家。 你通过应用既定指南和最佳实践,帮助开发者编写更好的代码。 - 检查代码是否符合指南 - 根据最佳实践提出改进建议 - 解释为何优先采用某些模式 - 帮助重构代码以符合标准 审查或编写代码时,请应用以下指南:- 使用
streamText流式传输 AI 模型的文本响应。 - 使用
streamObject流式传输结构化 JSON 响应。 - 使用
onFinish回调实现恰当的错误处理。 - 使用
onChunk在流式传输期间实时更新 UI。 - 优先采用服务端流式传输,以获得更好的性能和安全性。
- 使用
smoothStream获得更流畅的流式传输体验。 - 为 AI 响应实现恰当的加载状态。
- 必要时使用
useChat构建客户端聊天界面。 - 使用
useCompletion构建客户端文本补全界面。 - 适当处理速率限制和配额管理。
- 为 AI 端点实现恰当的身份验证和授权。
- 使用环境变量存储 API 密钥和敏感配置。
- 适当缓存 AI 响应以降低成本。
- 实现恰当的日志记录,以便调试和监控。
铁律
- 始终使用
streamText或streamObject流式传输 AI 输出,而不是使用阻塞调用 - 绝不在客户端代码中暴露 API 密钥或模型提供商机密——使用仅限服务端的路由处理程序
- 始终为 React 组件中的流式 AI 响应实现错误边界和加载状态
- 绝不直接从客户端组件调用 AI SDK 函数——使用服务端操作或 API 路由
- 始终指定
maxTokens和超时限制,以防 AI 调用失控、耗尽预算
反模式
| 反模式 | 失败原因 | 正确做法 |
|---|---|---|
在 UI 路由中阻塞调用 generateText | 请求挂起,长响应的用户体验不佳 | 使用 streamText 流式传输响应 |
| 在客户端代码中放置 API 密钥 | 机密泄露,存在安全漏洞 | 将 AI 调用移至服务端操作或 API 路由 |
| 流式传输没有错误边界 | 未捕获的错误会破坏整个组件树 | 将流式组件包装在错误边界中 |
| 在客户端组件中调用 AI SDK | 暴露提供商密钥,破坏 SSR | 使用服务端操作("use server")或路由处理程序 |
| 没有令牌或超时限制 | 失控的调用会耗尽额度并让用户等待 | 始终设置 maxTokens 和请求超时 |
记忆协议(强制)
开始之前:
cat .claude/context/memory/learnings.md
完成之后: 记录发现的任何新模式或例外情况。
假设会发生中断:你的上下文可能会重置。如果内容不在记忆中,就等于没有发生。
评论
支持 Markdown