bee-agent-framework

Bee Agent Framework

Open-source framework for building, deploying, and serving powerful multi-agent workflows at scale.

🐝 Bee Agent Framework is an open-source TypeScript library for building production-ready multi-agent systems. Pick from a variety of 🌐 AI Providers, customize the 📜 prompt templates, create 🤖 agents, equip agents with pre-made 🛠️ tools, and orchestrate 🤖🤝🤖 multi-agent workflows! 🪄

Latest updates

• 🚀 2025-02-07: Introduced Backend module to simplify working with AI services (chat, embedding). See migration guide.
• 🧠 2025-01-28: Added support for DeepSeek R1, check out the Competitive Analysis Workflow example
• 🚀 2025-01-09:
  • Introduced Workflows, a way of building multi-agent systems.
  • Added support for Model Context Protocol, featured on the official page.
• 🚀 2024-12-09: Added support for LLaMa 3.3.
• 🚀 2024-11-21: Added an experimental Streamlit agent.

For a full changelog, see the releases page.

Why pick Bee?

• ⚔️ Battle-tested. Bee Agent Framework is at the core of BeeAI, a powerful platform for building chat assistants and custom AI-powered apps. BeeAI is in a closed beta, but already used by hundreds of users. And it's fully open-source too!
• 🚀 Production-grade. In an actual product, you have to reduce token spend through memory strategies, store and restore the agent state through (de)serialization, generate structured output, or execute generated code in a sandboxed environment. Leave all that to Bee and focus on building!
• 🤗 Built for open-source models. Pick any LLM you want – including small and open-source models. The framework is designed to perform robustly with Granite and Llama 3.x. A full agentic workflow can run on your laptop!
• 😢 Bee cares about the sad path too. Real-world applications encounter errors and failures. Bee lets you observe the full agent workflow through events, collect telemetry, log diagnostic data, and throws clear and well-defined exceptions. Bees may be insects, but not bugs!
• 🌳 A part of something greater. Bee isn't just a framework, but a full ecosystem. Use Bee UI to chat with your agents visually. Bee Observe collects and manages telemetry. Bee Code Interpreter runs generated code safely in a secure sandbox. The Bee ecosystem also integrates with Model Context Protocol, allowing interoperability with the wider agent ecosystem!

Quick example

This example demonstrates how to build a multi-agent workflow using Bee Agent Framework:

import "dotenv/config";
import { UnconstrainedMemory } from "bee-agent-framework/memory/unconstrainedMemory";
import { OpenMeteoTool } from "bee-agent-framework/tools/weather/openMeteo";
import { WikipediaTool } from "bee-agent-framework/tools/search/wikipedia";
import { AgentWorkflow } from "bee-agent-framework/experimental/workflows/agent";
import { Message, Role } from "bee-agent-framework/llms/primitives/message";
import { GroqChatLLM } from "bee-agent-framework/adapters/groq/chat";

const workflow = new AgentWorkflow();

workflow.addAgent({
  name: "Researcher",
  instructions: "You are a researcher assistant. Respond only if you can provide a useful answer.",
  tools: [new WikipediaTool()],
  llm: new GroqChatLLM(),
});

workflow.addAgent({
  name: "WeatherForecaster",
  instructions: "You are a weather assistant. Respond only if you can provide a useful answer.",
  tools: [new OpenMeteoTool()],
  llm: new GroqChatLLM(),
  execution: { maxIterations: 3 },
});

workflow.addAgent({
  name: "Solver",
  instructions:
    "Your task is to provide the most useful final answer based on the assistants' responses which all are relevant. Ignore those where assistant do not know.",
  llm: new GroqChatLLM(),
});

const memory = new UnconstrainedMemory();

await memory.add(
  Message.of({
    role: Role.USER,
    text: "What is the capital of France and what is the current weather there?",
    meta: { createdAt: new Date() },
  }),
);

const { result } = await workflow.run(memory.messages).observe((emitter) => {
  emitter.on("success", (data) => {
    console.log(`-> ${data.step}`, data.response?.update?.finalAnswer ?? "-");
  });
});

console.log(`Agent 🤖`, result.finalAnswer);

Getting started

[!TIP]

🚀 Would you like a fully set-up TypeScript project with Bee, Code Interpreter, and Observability? Check out our Bee Framework Starter.

[!TIP]

🚀 Would you like to work with Bee in your web browser? See Bee Stack

Installation

npm install bee-agent-framework

or

yarn add bee-agent-framework

Example

import { BeeAgent } from "bee-agent-framework/agents/bee/agent";
import { OllamaChatModel } from "bee-agent-framework/adapters/ollama/backend/chat";
import { TokenMemory } from "bee-agent-framework/memory/tokenMemory";
import { DuckDuckGoSearchTool } from "bee-agent-framework/tools/search/duckDuckGoSearch";
import { OpenMeteoTool } from "bee-agent-framework/tools/weather/openMeteo";

const llm = new OllamaChatModel("llama3.1"); // default is llama3.1 (8B), it is recommended to use 70B model

const agent = new BeeAgent({
  llm, // for more explore 'bee-agent-framework/adapters'
  memory: new TokenMemory(), // for more explore 'bee-agent-framework/memory'
  tools: [new DuckDuckGoSearchTool(), new OpenMeteoTool()], // for more explore 'bee-agent-framework/tools'
});

const response = await agent
  .run({ prompt: "What's the current weather in Las Vegas?" })
  .observe((emitter) => {
    emitter.on("update", async ({ data, update, meta }) => {
      console.log(`Agent (${update.key}) 🤖 : `, update.value);
    });
  });

console.log(`Agent 🤖 : `, response.result.text);

➡️ See a more advanced example.

➡️ you can run this example after local installation, using the command yarn start examples/agents/simple.ts

[!TIP]

To run this example, be sure that you have installed ollama with the llama3.1 model downloaded.

[!TIP]

Documentation is available at https://i-am-bee.github.io/bee-agent-framework/

Local Installation

[!NOTE]

yarn should be installed via Corepack (tutorial)

• Clone the repository git clone [e-mail]:i-am-bee/bee-agent-framework.
• Install dependencies yarn install --immutable && yarn prepare.
• Create .env (from .env.template) and fill in missing values (if any).
• Start the agent yarn run start:bee (it runs /examples/agents/bee.ts file).

➡️ All examples can be found in the examples directory.

➡️ To run an arbitrary example, use the following command yarn start examples/agents/bee.ts (just pass the appropriate path to the desired example).

📦 Modules

The source directory (src) provides numerous modules that one can use.

Name	Description
agents	Base classes defining the common interface for agent.
workflows	Build agentic applications in a declarative way via workflows.
backend	Functionalities that relates to AI models (chat, embedding, image, tool calling, ...)
template	Prompt Templating system based on Mustache with various improvements.
memory	Various types of memories to use with agent.
tools	Tools that an agent can use.
cache	Preset of different caching approaches that can be used together with tools.
errors	Error classes and helpers to catch errors fast.
logger	Core component for logging all actions within the framework.
serializer	Core component for the ability to serialize/deserialize modules into the serialized format.
version	Constants representing the framework (e.g., latest version)
emitter	Bringing visibility to the system by emitting events.
internals	Modules used by other modules within the framework.

To see more in-depth explanation see overview.

Roadmap

• Python version
• Multi-agent orchestration patterns
• Catalog of agents

Contribution guidelines

The Bee Agent Framework is an open-source project and we ❤️ contributions.

If you'd like to contribute to Bee, please take a look at our contribution guidelines.

Bugs

We are using GitHub Issues to manage our public bugs. We keep a close eye on this, so before filing a new issue, please check to make sure it hasn't already been logged.

Code of conduct

This project and everyone participating in it are governed by the Code of Conduct. By participating, you are expected to uphold this code. Please read the full text so that you can read which actions may or may not be tolerated.

Legal notice

All content in these repositories including code has been provided by IBM under the associated open source software license and IBM is under no obligation to provide enhancements, updates, or support. IBM developers produced this code as an open source project (not as an IBM product), and IBM makes no assertions as to the level of quality nor security, and will not be maintaining this code going forward.

Contributors

Special thanks to our contributors for helping us improve Bee Agent Framework.