前言¶
在 VoltAgent 项目里改 Agent、Workflow 或工具时，编码助手往往只能依赖训练数据或网上搜到的文档。官网文档和 npm 包版本不一定一致，API 签名、配置字段很容易对不上，排查会变成「猜版本」。
下面介绍 VoltAgent 官方维护的 Agent Skill voltagent-docs-bundle：它不要求助手背全站文档，而是按固定路径去读随 @voltagent/core 一起安装的 Markdown 文档，让回答与当前依赖版本对齐。对 Agent 框架类 Skill 来说，把「文档源」绑在 node_modules 而不是远程 URL，是一种可复用的做法。
这是什么¶
voltagent-docs-bundle 是一份 SKILL.md 格式的指令：教编码 Agent 在本地查找 VoltAgent 文档，用于 API 签名、指南与示例。
- 维护方：VoltAgent（metadata 中 author 为 VoltAgent）
- 归属仓库：VoltAgent/skills，路径
skills/voltagent-docs-bundle - 许可证：MIT
- Skill 版本：1.0.0（见 Skill 元数据）
官方说明：文档嵌在 node_modules/@voltagent/core/docs，内容与网站文档镜像，并包含额外文档集，适合用来做版本匹配的查阅。
文档在哪里¶
已安装 @voltagent/core 时，文档根目录为：
node_modules/@voltagent/core/docs/
目录结构（节选，以官方 Skill 为准）包括 getting-started/、api/、workflows/、tools/、rag/、recipes/、deployment-docs/ 等，根下还有 actions.md、evals.md、triggers.md 等单文件。
若在 VoltAgent monorepo 内开发，同等内容在：
packages/core/docs/
前提：项目里已经通过 npm 安装了对应版本的 @voltagent/core；没有该包时，上述路径不存在，需要先完成项目依赖安装。
核心功能¶
Skill 描述中的能力均可从官方说明核对：
- 版本匹配：文档随已安装的
@voltagent/core打包，避免只看网站旧版或训练数据里的过时 API。 - 覆盖面：指南、API、recipes、部署与可观测性等目录均在
docs树下，Skill 建议用rg在*.md中检索主题。 - 查询流程标准化：先列目录、再关键词搜索、再读具体文件，减少 Agent 随意编造接口。
官方归纳的「Why This Works」三点：文档与安装版本绑定；避免 Web 内容与本地版本漂移；覆盖完整文档面（guides、recipes、platform docs）。
安装与启用¶
该 Skill 来自 VoltAgent 官方 Skill 集合，仓库说明支持通过 add-skill 类工具安装整库：
npx skills add VoltAgent/skills
安装后，在支持 Agent Skills 的编码助手（如 Cursor、Claude Code、Codex 等，见 agentskills.io 与各平台文档）中加载对应 Skill 目录即可。具体加载方式因平台而异：例如 Claude Code 常用 /skills add 加 GitHub 地址；其他环境可参考 awesome-agent-skills 中的「Using Skills」与各 Agent 文档。
手动方式（官方仓库 README）：克隆 https://github.com/VoltAgent/skills.git，再配置助手从克隆目录读取 Skills。用户任务要求不通过 git clone 演示安装，此处仅作官方文档记录。
同一仓库中与 VoltAgent 相关的其他 Skill 包括 create-voltagent、voltagent-best-practices、voltagent-core-reference；voltagent-docs-bundle 专门负责嵌入式文档查阅，可与前几项搭配使用。
在线文档入口（补充阅读，非本 Skill 的优先数据源）：https://voltagent.dev/docs
典型用法¶
Skill 内定义的查阅流程可直接交给 Agent 执行，或在终端自行验证。
1、列出可用章节
ls node_modules/@voltagent/core/docs
用于确认当前版本下有哪些顶层目录与文件。
2、按主题搜索
rg -n "workflow" node_modules/@voltagent/core/docs -g"*.md"
将 workflow 换成 memory、guardrails 等关键词，定位相关 Markdown 路径与行号。
3、阅读具体页面
cat node_modules/@voltagent/core/docs/workflows/overview.md
例如快速入门可读：
cat node_modules/@voltagent/core/docs/getting-started/quick-start.md
向助手提问时，可明确说明「按 voltagent-docs-bundle，在 node_modules/@voltagent/core/docs 查当前版本的 XXX」，便于触发 Skill 中的路径与命令，而不是泛搜网络。
适用场景与注意¶
适合
- 已在项目中安装
@voltagent/core，需要改 Agent、Workflow、工具、RAG、部署相关代码。 - 需要 API 签名、配置项、示例与当前 lockfile / package 版本一致。
- 在 monorepo 的
packages/core/docs与消费方项目的node_modules之间切换时，仍沿用同一套目录约定。
注意
- 未安装
@voltagent/core时，嵌入式文档不存在；应先npm install（或项目既有安装流程），再查docs。 - Skill 依赖 shell 与
rg（ripgrep）；环境若无rg，需安装或改用等价搜索方式，官方 Quick Commands 以rg为例。 - 网站 voltagent.dev/docs 便于浏览，但若要与本地代码版本严格一致，应优先
node_modules/@voltagent/core/docs。 - 本 Skill 是指令文档，不包含自动索引服务；大规模检索仍依赖列目录、
rg与按需cat/读文件。
结尾¶
voltagent-docs-bundle 把 VoltAgent 文档查阅锚定在 @voltagent/core 自带的 docs 目录，用版本绑定的 Markdown 替代「猜官网版本」，适合作为框架官方 Skill 里文档类能力的参考实现。
官方 Skill 地址：https://github.com/voltagent/skills/tree/main/skills/voltagent-docs-bundle
