voltagent/skills
Overview
This skill looks up VoltAgent documentation embedded in node_modules/@voltagent/core/docs and returns version-matched docs for API signatures, guides, and examples. It reads the local bundle shipped with the installed package, ensuring answers match the exact runtime version. Use it to fetch reliable reference material without depending on the website.
How this skill works
The skill lists available doc sections in node_modules/@voltagent/core/docs (or packages/core/docs inside the monorepo), searches Markdown files for keywords, and reads specific files to extract relevant content. It mirrors the website docs plus extra doc sets, so content is consistent with the installed package version. Typical operations include listing directories, running ripgrep searches, and returning file contents for the requested topic.
When to use it
- You need API signatures or method details that must match the installed VoltAgent version.
- You want guides, examples, or recipes bundled with the package rather than the live website.
- Troubleshooting or deployment instructions that should align exactly with local code.
- Quick lookups while developing inside the monorepo or a project that installs @voltagent/core.
Best practices
- Prefer local lookups for version-sensitive answers to avoid web drift.
- Search by keyword across *.md files (rg -n) before opening individual files.
- Target files under specific sections (workflows, agents, integrations) to reduce noise.
- Verify the package version if you need docs from a different release.
- When in the monorepo, use packages/core/docs for identical content.
Example use cases
- Fetch an API signature for an action or agent from api/ or actions.md.
- Open quick-start and getting-started guides from getting-started/quick-start.md.
- Search for guardrail or observability instructions across the docs with ripgrep.
- Retrieve workflow examples from workflows/overview.md for adapting to a new project.
- Look up deployment and troubleshooting steps in deployment-docs/ and troubleshooting/.
FAQ
They match the installed package version. If your node_modules copy corresponds to the runtime version, the docs will be consistent. For development inside the monorepo, use packages/core/docs.
How do I search for a specific keyword across the docs?
Use ripgrep, for example: rg -n "keyword" node_modules/@voltagent/core/docs -g"*.md" to list matches and file locations.
2 skills
This skill retrieves version-matched VoltAgent documentation from embedded docs to answer API signatures, guides, and examples.
This skill guides you through creating VoltAgent projects with CLI flows or manual setup, accelerating bootstrapping and correct configuration.
