前言¶
在 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
