voltagent

<div align="center"> <a href="https://voltagent.dev/"> <img width="1800" alt="435380213-b6253409-8741-462b-a346-834cd18565a9" src="https://github.com/user-attachments/assets/452a03e7-eeda-4394-9ee7-0ffbcf37245c" /> </a> <br/> <br/> <div align="center"> English | <a href="i18n/README-cn-traditional.md">繁體中文</a> | <a href="i18n/README-cn-bsc.md">简体中文</a> | <a href="i18n/README-jp.md">日本語</a> | <a href="i18n/README-kr.md">한국어</a> </div> <br/> <div align="center"> <a href="https://voltagent.dev">Home Page</a> | <a href="https://voltagent.dev/docs/">Documentation</a> | <a href="https://github.com/voltagent/voltagent/tree/main/examples">Examples</a> | <a href="https://s.voltagent.dev/discord">Discord</a> | <a href="https://voltagent.dev/blog/">Blog</a> </div> </div> <br/> <div align="center"> <strong>VoltAgent is an open source TypeScript framework for building and orchestrating AI agents.</strong><br> Escape the limitations of no-code builders and the complexity of starting from scratch. <br /> <br /> </div> <div align="center"> [](https://www.npmjs.com/package/@voltagent/core) [](CODE_OF_CONDUCT.md) [](https://s.voltagent.dev/discord) [](https://twitter.com/voltagent_dev) </div> <br/> <div align="center"> <a href="https://voltagent.dev/"> <img width="896" alt="flow" src="https://github.com/user-attachments/assets/f0627868-6153-4f63-ba7f-bdfcc5dd603d" /> </a> </div> ## What is VoltAgent? > An **AI Agent Framework** provides the foundational structure and tools needed to build applications powered by autonomous agents. These agents, often driven by Large Language Models (LLMs), can perceive their environment, make decisions, and take actions to achieve specific goals. Building such agents from scratch involves managing complex interactions with LLMs, handling state, connecting to external tools and data, and orchestrating workflows. **VoltAgent** is an open-source TypeScript framework that acts as this essential toolkit. It simplifies the development of AI agent applications by providing modular building blocks, standardized patterns, and abstractions. Whether you're creating chatbots, virtual assistants, automated workflows, or complex multi-agent systems, VoltAgent handles the underlying complexity, allowing you to focus on defining your agents' capabilities and logic. Instead of building everything from scratch, VoltAgent provides ready-made, modular building blocks: - **Core Engine (`@voltagent/core`)**: The heart of VoltAgent, providing fundamental capabilities for your AI agents Define individual agents with specific roles, tools, and memory. - **Multi-Agent Systems**: Architect complex applications by coordinating multiple specialized agents using Supervisors. - **Workflow Engine**: Go beyond simple request-response. Orchestrate multi-step automations that can process data, call APIs, run tasks in parallel, and execute conditional logic. - **Extensible Packages**: Enhance functionality with packages like `@voltagent/voice` for voice interactions. - **Tooling & Integrations**: Equip agents with tools to connect to external APIs, databases, and services, enabling them to perform real-world tasks. **Supports the [Model Context Protocol (MCP)](https://modelcontextprotocol.io/) for standardized tool interactions.** - **Data Retrieval & RAG**: Implement specialized retriever agents for efficient information fetching and **Retrieval-Augmented Generation (RAG)**. - **Memory**: Enable agents to remember past interactions for more natural and context-aware conversations. - **LLM Compatibility**: Works with popular AI models from OpenAI, Google, Anthropic, and more, allowing easy switching. - **Developer Ecosystem**: Includes helpers like `create-voltagent-app`, `@voltagent/cli`, and the visual [VoltOps LLM Observability Platform](https://console.voltagent.dev) for quick setup, monitoring, and debugging. In essence, VoltAgent helps developers build sophisticated AI applications faster and more reliably, avoiding repetitive setup and the limitations of simpler tools. ## Why VoltAgent? Building AI applications often involves a trade-off: 1. **DIY Approach:** Using basic AI provider tools offers control but leads to complex, hard-to-manage code and repeated effort. 2. **No-Code Builders:** Simpler initially but often restrictive, limiting customization, provider choice, and complexity. VoltAgent provides a middle ground, offering structure and components without sacrificing flexibility: - **Build Faster:** Accelerate development with pre-built components compared to starting from scratch. - **Maintainable Code:** Encourages organization for easier updates and debugging. - **Scalability:** Start simple and easily scale to complex, multi-agent systems handling intricate workflows. - **Build Sophisticated Automations:** It's not just for chat. The workflow engine lets you build complex, multi-step processes for tasks like data analysis pipelines, automated content generation, or intelligent decision-making systems. - **Flexibility:** Full control over agent behavior, LLM choice, tool integrations, and UI connections. - **Avoid Lock-in:** Freedom to switch AI providers and models as needed. - **Cost Efficiency:** Features designed to optimize AI service usage and reduce redundant calls. - **Visual Monitoring:** Use the [VoltOps LLM Observability Platform](https://console.voltagent.dev) to track agent performance, inspect state, and debug visually. VoltAgent empowers developers to build their envisioned AI applications efficiently, from simple helpers to complex systems. ## ⚡ Quick Start Create a new VoltAgent project in seconds using the `create-voltagent-app` CLI tool: ```bash npm create voltagent-app@latest ``` This command guides you through setup. You'll see the starter code in `src/index.ts`, which now registers both an agent and a comprehensive workflow example found in `src/workflows/index.ts`. ```typescript import { VoltAgent, Agent } from "@voltagent/core"; import { LibSQLStorage } from "@voltagent/libsql"; import { createPinoLogger } from "@voltagent/logger"; import { VercelAIProvider } from "@voltagent/vercel-ai"; import { openai } from "@ai-sdk/openai"; import { expenseApprovalWorkflow } from "./workflows"; import { weatherTool } from "./tools"; // Create a logger instance const logger = createPinoLogger({ name: "my-agent-app", level: "info", }); // A simple, general-purpose agent for the project. const agent = new Agent({ name: "my-agent", instructions: "A helpful assistant that can check weather and help with various tasks", llm: new VercelAIProvider(), model: openai("gpt-4o-mini"), tools: [weatherTool], memory: new LibSQLStorage({ url: "file:./.voltagent/memory.db", logger: logger.child({ component: "libsql" }), }), }); // Initialize VoltAgent with your agent(s) and workflow(s) new VoltAgent({ agents: { agent, }, workflows: { expenseApprovalWorkflow, }, logger, }); ``` Afterwards, navigate to your project and run: ```bash npm run dev ``` When you run the dev command, tsx will compile and run your code. You should see the VoltAgent server startup message in your terminal: ``` ══════════════════════════════════════════════════ VOLTAGENT SERVER STARTED SUCCESSFULLY ══════════════════════════════════════════════════ ✓ HTTP Server: http://localhost:3141 Test your agents with VoltOps Console: https://console.voltagent.dev ══════════════════════════════════════════════════ ``` Your agent is now running! To interact with it: 1. Open the Console: Click the [VoltOps LLM Observability Platform](https://console.voltagent.dev) link in your terminal output (or copy-paste it into your browser). 2. Find Your Agent: On the VoltOps LLM Observability Platform page, you should see your agent listed (e.g., "my-agent"). 3. Open Agent Details: Click on your agent's name. 4. Start Chatting: On the agent detail page, click the chat icon in the bottom right corner to open the chat window. 5. Send a Message: Type a message like "Hello" and press Enter. [](https://console.voltagent.dev/) ### Running Your First Workflow Your new project also includes a powerful workflow engine. You can test the pre-built `expenseApprovalWorkflow` directly from the VoltOps console:  1. **Go to the Workflows Page:** After starting your server, go directly to the [Workflows page](https://console.voltagent.dev/workflows). 2. **Select Your Project:** Use the project selector to choose your project (e.g., "my-agent-app"). 3. **Find and Run:** You will see **"Expense Approval Workflow"** listed. Click it, then click the **"Run"** button. 4. **Provide Input:** The workflow expects a JSON object with expense details. Try a small expense for automatic approval: ```json { "employeeId": "EMP-123", "amount": 250, "category": "office-supplies", "description": "New laptop mouse and keyboard" } ``` 5. **View the Results:** After execution, you can inspect the detailed logs for each step and see the final output directly in the console. ## Key Features - **Agent Core:** Define agents with descriptions, LLM providers, tools, and memory management. - **Workflow Engine:** Orchestrate complex, multi-step automations with a powerful and declarative API (`andThen`, `andAgent`, `andAll`, `andRace`, `andWhen`). - **Multi-Agent Systems:** Build complex workflows using Supervisor Agents coordinating multiple specialized Sub-Agents. - **Tool Usage & Lifecycle:** Equip agents with custom or pre-built tools (functions) with type-safety (Zod), lifecycle hooks, and cancellation support to interact with external systems. - **Flexible LLM Support:** Integrate seamlessly with various LLM providers (OpenAI, Anthropic, Google, etc.) and easily switch between models. - **Memory Management:** Enable agents to retain context across interactions using different configurable memory providers. - **Observability & Debugging:** Visually monitor agent states, interactions, logs, and performance via the [VoltOps LLM Observability Platform](https://console.voltagent.dev). - **Custom API Endpoints:** Extend the VoltAgent API server with your own custom endpoints to build specialized functionality on top of the core framework. - **Voice Interaction:** Build voice-enabled agents capable of speech recognition and synthesis using the `@voltagent/voice` package. - **Data Retrieval & RAG:** Integrate specialized retriever agents for efficient information fetching and **Retrieval-Augmented Generation (RAG)** from various sources. - **Model Context Protocol (MCP) Support:** Connect to external tool servers (HTTP/stdio) adhering to the [MCP standard](https://modelcontextprotocol.io/) for extended capabilities. - **Prompt Engineering Tools:** Leverage utilities like `createPrompt` for crafting and managing effective prompts for your agents. - **Framework Compatibility:** Designed for easy integration into existing Node.js applications and popular frameworks. ## Use Cases VoltAgent is versatile and can power a wide range of AI-driven applications: - **Complex Workflow Automation:** Orchestrate multi-step processes involving various tools, APIs, and decision points using coordinated agents. - **Intelligent Data Pipelines:** Build agents that fetch, process, analyze, and transform data from diverse sources. - **AI-Powered Internal Tools & Dashboards:** Create interactive internal applications that leverage AI for analysis, reporting, or task automation, often integrated with UIs using hooks. - **Automated Customer Support Agents:** Develop sophisticated chatbots that can understand context (memory), use tools (e.g., check order status), and escalate complex issues. - **Repository Analysis & Codebase Automation:** Analyze code repositories, automate refactoring tasks, generate documentation, or manage CI/CD processes. - **Retrieval-Augmented Generation (RAG) Systems:** Build agents that retrieve relevant information from knowledge bases (using retriever agents) before generating informed responses. - **Voice-Controlled Interfaces & Applications:** Utilize the `@voltagent/voice` package to create applications that respond to and generate spoken language. - **Personalized User Experiences:** Develop agents that adapt responses and actions based on user history and preferences stored in memory. - **Real-time Monitoring & Alerting:** Design agents that continuously monitor data streams or systems and trigger actions or notifications based on defined conditions. - **And Virtually Anything Else...**: If you can imagine an AI agent doing it, VoltAgent can likely help you build it! ⚡ ## Learning VoltAgent - **[Documentation](https://voltagent.dev/docs/)**: Dive into guides, concepts, and tutorials. - **[Examples](https://github.com/voltagent/voltagent/tree/main/examples)**: Explore practical implementations. - **[Blog](https://voltagent.dev/blog/)**: Read more about technical insights, and best practices. ## Contribution We welcome contributions! Please refer to the contribution guidelines (link needed if available). Join our [Discord](https://s.voltagent.dev/discord) server for questions and discussions. ## Contributor ♥️ Thanks Big thanks to everyone who's been part of the VoltAgent journey, whether you've built a plugin, opened an issue, dropped a pull request, or just helped someone out on Discord or GitHub Discussions. VoltAgent is a community effort, and it keeps getting better because of people like you.  Your stars help us reach more developers! If you find VoltAgent useful, please consider giving us a star on GitHub to support the project and help others discover it. ## License Licensed under the MIT License, Copyright © 2025-present VoltAgent.