VoltAgent Core Reference
Reference for the VoltAgent class: constructor options, lifecycle methods, and runtime behavior.
MCP get_skill({ skillId: "voltagent-core-reference-f0a19fbf" })Use this skill with your agent
Create a free account and connect via MCP
# VoltAgent Core Reference
Reference for the VoltAgent class in `@voltagent/core`.
Source files:
- packages/core/src/voltagent.ts
- packages/core/src/types.ts
---
## Options Overview
`VoltAgentOptions` supports:
- `agents`: Record of `Agent` instances to register.
- `workflows`: Record of `Workflow` or `WorkflowChain` instances.
- `memory`: Default `Memory` used for agents and workflows.
- `agentMemory`: Default `Memory` for agents (falls back to `memory`).
- `workflowMemory`: Default `Memory` for workflows (falls back to `memory`).
- `toolRouting`: Global `ToolRoutingConfig` defaults.
- `triggers`: `VoltAgentTriggersConfig` handlers.
- `server`: Server provider factory (for example `honoServer()`).
- `serverless`: Serverless provider factory for fetch runtimes.
- `voltOpsClient`: Shared `VoltOpsClient` instance.
- `observability`: `VoltAgentObservability` instance.
- `logger`: Shared `Logger` instance.
- `mcpServers`: Record of MCP servers or factories.
- `a2aServers`: Record of A2A servers or factories.
- `checkDependencies`: Set to `false` to skip dependency checks.
Deprecated options:
- `port`
- `autoStart`
- `customEndpoints`
- `enableSwaggerUI`
---
## Lifecycle Notes
- Registers agents and workflows on construction.
- Auto-starts the server if a server provider is supplied.
- Applies default memory to agents and workflows.
- Auto-configures VoltOps client from `VOLTAGENT_PUBLIC_KEY` and `VOLTAGENT_SECRET_KEY` if not provided.
- Initializes MCP and A2A servers and starts MCP transports after server start.
---
## Methods
- `registerAgent(agent)`, `registerAgents(agents)`
- `registerWorkflow(workflow)`, `registerWorkflows(workflows)`
- `registerTrigger(name, config)`, `registerTriggers(triggers)`
- `getAgent(id)`, `getAgents()`, `getAgentCount()`
- `getWorkflow(id)`, `getWorkflows()`, `getWorkflowCount()`
- `getObservability()`
- `startServer()`, `stopServer()`, `getServerInstance()`
- `serverless()` to access the serverless provider
- `shutdown()` for graceful shutdown, `shutdownTelemetry()` for observability
---
## Example
```typescript
import { VoltAgent } from "@voltagent/core";
import { honoServer } from "@voltagent/server-hono";
const app = new VoltAgent({
agents: { agent },
workflows: { workflow },
server: honoServer(),
});
await app.startServer();
```Related Skills
More skills in Agent Orchestration
1. Product type search — what design patterns fit this product?
Design UI/UX systems with style guides, palettes, typography, and component specs for new interfaces
Acp Router
Route plain-language requests for Claude Code, Cursor, Copilot, OpenClaw ACP, OpenCode, Gemini CLI, Qwen, Kiro, Kimi, iFlow, Factory Droid, Kilocode, or explicit ACP harness work into either OpenClaw ACP runtime sessions or direct acpx-driven sessions ("telephone game" flow). For coding-agent thread requests, read this skill first, then use only `sessions_spawn` for thread creation. Codex chat binding defaults to the native Codex app-server plugin unless ACP is explicit or background spawn needs ACP.
Add New Safe Output Type
Adding a New Safe Output Type to GitHub Agentic Workflows
Agent Governance
Patterns and techniques for adding governance, safety, and trust controls to AI agent systems. Use this skill when: - Building AI agents that call external tools (APIs, databases, file systems) - Implementing policy-based access controls for agent tool usage - Adding semantic intent classification to detect dangerous prompts - Creating trust scoring systems for multi-agent workflows - Building audit trails for agent actions and decisions - Enforcing rate limits, content filters, or tool restrictions on agents - Working with any agent framework (PydanticAI, CrewAI, OpenAI Agents, LangChain, AutoGen)
Agentic Development
Build AI agents with Pydantic AI (Python) and Claude SDK (Node.js)
Agentic Workflows
Route gh-aw workflow design/create/debug/upgrade requests to the right prompts.
Explore Other Categories
Skills from other categories with shared topics
API Design Principles
Master REST and GraphQL API design principles to build intuitive, scalable, and maintainable APIs that delight developers. Use when designing new APIs, reviewing API specifications, or establishing API design standards.
Azure Aks Agent Skill
Azure Aks Agent Skill linked from Juliano Barbosa Claude Code Skills, with the upstream skill instructions available on GitHub.
Changelog Automation
Automate changelog generation from commits, PRs, and releases following Keep a Changelog format. Use when setting up release workflows, generating release notes, or standardizing commit conventions.