Agent Forge 🔨

Agent Forge is a TypeScript framework for building, orchestrating, and running advanced AI agents and agent teams. It supports LLMs, tool use, hierarchical teams, remote agent protocols (A2A), and MCP tool integration. Designed for extensibility, composability, and real-world AI agent applications.

Features

Decorator-based agent definition: Use TypeScript decorators for agent config, LLM provider, tool integration, and remote protocols.
Tool ecosystem: Add built-in, custom, or MCP tools to agents.
Teams: Create hierarchical teams with a manager agent that delegates tasks.
Remote agents (A2A): Expose agents as remote services or connect to remote agents.
Streaming: Real-time streaming of LLM and agent outputs.
TypeScript-first: Full type safety and modern developer experience.

Installation

yarn add agent-forge
# or
npm install agent-forge

TypeScript Configuration

Agent Forge uses TypeScript decorators extensively. You must enable decorator support in your tsconfig.json file for the framework to work properly.

Add these options to your tsconfig.json:

{
  "compilerOptions": {
    "experimentalDecorators": true,
    "emitDecoratorMetadata": true
    // ... other options
  }
}

Example tsconfig.json

Here's a minimal tsconfig.json that works with Agent Forge:

{
  "compilerOptions": {
    "target": "es2020",
    "module": "commonjs",
    "lib": ["es2020"],
    "experimentalDecorators": true,
    "emitDecoratorMetadata": true,
    "strict": true,
    "esModuleInterop": true,
    "skipLibCheck": true,
    "forceConsistentCasingInFileNames": true,
    "declaration": true,
    "outDir": "./dist",
    "rootDir": "./src"
  },
  "include": ["src/**/*"],
  "exclude": ["node_modules", "dist"]
}

Prerequisites:

Node.js (latest LTS recommended)
LLM API keys (e.g., OpenAI)

Quick Start

1. Team of Local Agents

import { forge, llmProvider, agent, readyForge } from "agent-forge";
import { AgentForge, Agent } from "agent-forge";

@agent({
  name: "ManagerAgent",
  role: "Manager",
  description: "Delegates tasks to team members.",
  objective: "Coordinate the team to solve complex tasks.",
  model: process.env.LLM_API_MODEL!,
})
class ManagerAgent extends Agent {}

@agent({
  name: "ResearcherAgent",
  role: "Research Specialist",
  description: "Finds and analyzes information.",
  objective: "Provide accurate, relevant information.",
  model: process.env.LLM_API_MODEL!,
})
class ResearcherAgent extends Agent {}

@agent({
  name: "SummarizerAgent",
  role: "Summarizer",
  description: "Summarizes information.",
  objective: "Create concise summaries.",
  model: process.env.LLM_API_MODEL!,
})
class SummarizerAgent extends Agent {}

@llmProvider("openai", { apiKey: process.env.LLM_API_KEY })
@forge()
class TeamExample {
  static forge: AgentForge;

  static async run() {
    // Pass agent classes to readyForge - it will handle instantiation
    const agentClasses = [ManagerAgent, ResearcherAgent, SummarizerAgent];
    await readyForge(TeamExample, agentClasses);

    const team = TeamExample.forge
      .createTeam(
        "ManagerAgent",
        "Team",
        "A team of agents that can help with a variety of tasks."
      )
      .addAgent(TeamExample.forge.getAgent("ResearcherAgent")!)
      .addAgent(TeamExample.forge.getAgent("SummarizerAgent")!);
    const result = await team.run(
      "What is the status of AI in 2025? Make a full report and summary.",
      { verbose: true }
    );
    console.log(result.output);
  }
}

TeamExample.run();

Logging Configuration

Agent Forge provides comprehensive logging capabilities with configurable levels. You can control logging behavior at the decorator level for fine-grained control:

Basic Logging Configuration

import { forge, llmProvider, LogLevel } from "agent-forge";

@llmProvider("openai", { apiKey: process.env.OPENAI_API_KEY })
@forge({
  logger: {
    level: LogLevel.DEBUG,  // Enable debug logging
    enableConsoleLogging: true,
    enablePerformanceLogging: true
  }
})
class MyApplication {
  static forge: AgentForge;
}

Available Log Levels

LogLevel.DEBUG (0) - Most verbose, shows everything including LLM interactions
LogLevel.INFO (1) - Default level, shows info, warnings, errors, critical
LogLevel.WARNING (2) - Shows warnings, errors, critical
LogLevel.ERROR (3) - Shows only errors and critical issues
LogLevel.CRITICAL (4) - Shows only critical errors

Logger Configuration Options

interface ForgeConfig {
  logger?: {
    level: LogLevel;                 // Logging level
    enableConsoleLogging: boolean;   // Console output
    enableEventEmission: boolean;    // Event emission
    enablePerformanceLogging: boolean; // Performance tracking
    enableErrorAggregation: boolean; // Error counting
    maxLogHistory: number;           // Log history size
  };
}

Environment-Specific Examples

// Development: Debug everything
@forge({
  logger: {
    level: LogLevel.DEBUG,
    enableConsoleLogging: true,
    enablePerformanceLogging: true,
    enableErrorAggregation: true,
    maxLogHistory: 1000
  }
})
class DevEnvironment {}

// Production: Errors only
@forge({
  logger: {
    level: LogLevel.ERROR,
    enableConsoleLogging: true,
    enablePerformanceLogging: false,
    enableErrorAggregation: true,
    maxLogHistory: 100
  }
})
class ProductionEnvironment {}

// Default behavior (no config needed)
@forge() // Uses LogLevel.INFO with default settings

2. Workflows: Step-by-Step Task Automation

Agent Forge supports workflows, allowing you to define a sequence of agent steps for complex, multi-stage tasks. Workflows are ideal when you want to chain agent outputs, such as research followed by summarization.

import { forge, llmProvider, agent, readyForge, LogLevel } from "agent-forge";
import { AgentForge, Agent, LLMProvider } from "agent-forge";
import * as dotenv from "dotenv";

dotenv.config();

@agent({
  name: "Researcher",
  role: "Research Specialist",
  description: "A specialized agent for gathering and analyzing information.",
  objective: "Find accurate and relevant information on requested topics.",
  model: process.env.LLM_API_MODEL!,
  temperature: 0.4,
})
class ResearcherAgent extends Agent {}

@agent({
  name: "Summarizer",
  role: "Concise Summarizer",
  description:
    "An agent that specializes in distilling information into clear summaries.",
  objective: "Create concise, accurate summaries of complex information.",
  model: process.env.LLM_API_MODEL!,
  temperature: 0.4,
})
class SummarizerAgent extends Agent {}

@llmProvider(process.env.LLM_PROVIDER as LLMProvider, {
  apiKey: process.env.LLM_API_KEY,
})
@forge({
  logger: {
    level: LogLevel.INFO,  // Balanced logging for workflow tracking
    enablePerformanceLogging: true
  }
})
class WorkflowExample {
  static forge: AgentForge;

  static async run() {
    const agentClasses = [ResearcherAgent, SummarizerAgent];
    await readyForge(WorkflowExample, agentClasses);

    // Create a workflow: research, then summarize
    const workflow = WorkflowExample.forge.createWorkflow(
      "Research and Summarize",
      "Research a topic and then summarize the findings"
    );
    workflow.addStep(WorkflowExample.forge.getAgent("Researcher")!); // Researcher
    workflow.addStep(WorkflowExample.forge.getAgent("Summarizer")!); // Summarizer

    const result = await workflow.run(
      "What is quantum computing and how might it affect cybersecurity?",
      { verbose: true }
    );
    console.log("Workflow Result:", result.output);
  }
}

WorkflowExample.run();

What this does:

Defines two agents: a Researcher and a Summarizer.
Registers them with the forge instance.
Creates a workflow where the Researcher investigates a topic, and the Summarizer condenses the findings.
Runs the workflow on a sample question and prints the result.

3. Expose an Agent as a Remote A2A Server

import { a2aServer, agent, llmProvider } from "agent-forge";
import { Agent } from "agent-forge";

@llmProvider("openai", { apiKey: process.env.LLM_API_KEY })
@a2aServer({ port: 41241, host: "localhost", endpoint: "/a2a", verbose: true })
@agent({
  name: "HelpfulAssistantAgent",
  role: "Helpful Assistant",
  description: "An AI assistant that tries to be helpful, hosted via A2A.",
  objective: "To answer questions and perform tasks as a helpful AI assistant.",
  model: process.env.LLM_API_MODEL!,
})
export class HelpfulAssistantAgent extends Agent {}

new HelpfulAssistantAgent();
console.log("A2A server started. Press Ctrl+C to stop.");

4. Connect to a Remote Agent (A2A Client)

import { a2aClient } from "agent-forge";
import { Agent } from "agent-forge";

@a2aClient({ serverUrl: "http://localhost:41241/a2a" })
export class RemoteHelpfulAssistant extends Agent {}

(async () => {
  const remoteAgent = await new RemoteHelpfulAssistant();
  const result = await remoteAgent.run("Summarize the latest AI trends.");
  console.log(result.output);
})();

5. Team with a Remote Agent as a Member

import { forge, llmProvider, agent, a2aClient } from "agent-forge";
import { AgentForge, Agent } from "agent-forge";

@agent({
  name: "ManagerAgent",
  role: "Manager",
  description: "Delegates tasks to team members.",
  objective: "Coordinate the team to solve complex tasks.",
  model: process.env.LLM_API_MODEL!,
})
class ManagerAgent extends Agent {}

@agent({
  name: "SummarizerAgent",
  role: "Summarizer",
  description: "Summarizes information.",
  objective: "Create concise summaries.",
  model: process.env.LLM_API_MODEL!,
})
class SummarizerAgent extends Agent {}

@a2aClient({ serverUrl: "http://localhost:41241/a2a" })
class RemoteHelpfulAssistant extends Agent {}

@llmProvider("openai", { apiKey: process.env.LLM_API_KEY })
@forge()
class TeamWithRemoteExample {
  static forge: AgentForge;

  static async run() {
    // Pass both local and remote agent classes to readyForge
    const agentClasses = [
      ManagerAgent,
      SummarizerAgent,
      RemoteHelpfulAssistant,
    ];
    await readyForge(TeamWithRemoteExample, agentClasses);

    const team = TeamWithRemoteExample.forge
      .createTeam("ManagerAgent", "Hybrid Team", "A team with a remote agent")
      .addAgent(TeamWithRemoteExample.forge.getAgent("SummarizerAgent")!)
      .addAgent(
        TeamWithRemoteExample.forge.getAgent("RemoteHelpfulAssistant")!
      );
    const result = await team.run(
      "What are the most important AI trends in 2025? Summarize the findings.",
      { verbose: true }
    );
    console.log(result.output);
  }
}

TeamWithRemoteExample.run();

5. Using Tools with Agents

Agent Forge provides a powerful tool system that allows agents to interact with external systems, APIs, and services. Tools can be added to agents using the @tool decorator.

Adding Tools with the `@tool` Decorator

import { agent, tool, llmProvider, forge } from "agent-forge";
import {
  Agent,
  AgentForge,
  WebSearchTool,
  WebPageContentTool,
} from "agent-forge";

@tool(WebSearchTool)
@tool(WebPageContentTool)
@agent({
  name: "ResearchAgent",
  role: "Research Assistant",
  description:
    "An agent that can search the web and extract content from pages.",
  objective: "Help users find and analyze information from the web.",
  model: process.env.LLM_API_MODEL!,
  temperature: 0.7,
})
class ResearchAgent extends Agent {}

@llmProvider("openai", { apiKey: process.env.LLM_API_KEY })
@forge()
class ToolExample {
  static forge: AgentForge;

  static async run() {
    const agentClasses = [ResearchAgent];
    await readyForge(ToolExample, agentClasses);

    const result = await ToolExample.forge.runAgent(
      "ResearchAgent",
      "Search for the latest developments in quantum computing and summarize the findings"
    );
    console.log(result.output);
  }
}

ToolExample.run();

Creating Custom Tools

You can create custom tools by extending the Tool base class:

import { Tool } from "agent-forge";
import { ToolParameter } from "agent-forge";

class CalculatorTool extends Tool {
  constructor() {
    const parameters: ToolParameter[] = [
      {
        name: "expression",
        type: "string",
        description: "The mathematical expression to evaluate",
        required: true,
      },
    ];

    super(
      "Calculator",
      "Evaluate mathematical expressions",
      parameters,
      "The result of the evaluated expression"
    );
  }

  protected async run(params: { expression: string }): Promise<any> {
    try {
      // Note: In production, use a proper math parser instead of eval
      const result = eval(params.expression);
      return { result, expression: params.expression };
    } catch (error) {
      return {
        error: `Failed to evaluate expression: ${
          error instanceof Error ? error.message : String(error)
        }`,
      };
    }
  }
}

class WeatherTool extends Tool {
  constructor() {
    const parameters: ToolParameter[] = [
      {
        name: "location",
        type: "string",
        description: "The location to get weather for",
        required: true,
      },
      {
        name: "units",
        type: "string",
        description: "Temperature units (celsius or fahrenheit)",
        required: false,
        default: "celsius",
      },
    ];

    super(
      "Weather",
      "Get current weather information for a location",
      parameters,
      "Weather information including temperature, conditions, and forecast"
    );
  }

  protected async run(params: {
    location: string;
    units?: string;
  }): Promise<any> {
    // This is a mock implementation. In production, call a real weather API
    const { location, units = "celsius" } = params;

    return {
      location,
      temperature: units === "celsius" ? "22°C" : "72°F",
      conditions: "Partly cloudy",
      forecast: "Sunny tomorrow",
      humidity: "65%",
      windSpeed: "10 km/h",
    };
  }
}

// Use the custom tools with an agent
@tool(CalculatorTool)
@tool(WeatherTool)
@agent({
  name: "Assistant",
  role: "General Assistant",
  description: "A helpful assistant with calculator and weather capabilities.",
  objective: "Help users with calculations and weather information.",
  model: process.env.LLM_API_MODEL!,
  temperature: 0.7,
})
class AssistantAgent extends Agent {}

Tool Requirements

When creating custom tools, follow these guidelines:

Extend the Tool base class: Your tool must inherit from Tool
Define parameters: Specify what parameters your tool accepts using ToolParameter[]
Implement the run method: This is where your tool's logic goes
Handle errors gracefully: Return error information instead of throwing when possible
Return structured data: Return objects that the LLM can easily understand and use

Tool Parameter Types

Supported parameter types:

string: Text input
number: Numeric input
boolean: True/false values
array: List of values
object: Structured data

const parameters: ToolParameter[] = [
  {
    name: "query",
    type: "string",
    description: "The search query",
    required: true,
  },
  {
    name: "maxResults",
    type: "number",
    description: "Maximum number of results to return",
    required: false,
    default: 10,
  },
  {
    name: "includeImages",
    type: "boolean",
    description: "Whether to include images in results",
    required: false,
    default: false,
  },
];

6. Team with MCP Tool Agent

import { agent, llmProvider, forge, MCP, RateLimiter } from "agent-forge";
import { Agent, AgentForge } from "agent-forge";
import { MCPProtocolType } from "agent-forge/tools/mcp-tool";

@RateLimiter({
  rateLimitPerSecond: 1,
  toolSpecificLimits: {
    brave: { rateLimitPerSecond: 1 },
  },
  verbose: true,
})
@MCP(MCPProtocolType.STDIO, {
  command: "docker",
  args: ["run", "-i", "--rm", "-e", "BRAVE_API_KEY", "mcp/brave-search"],
  env: {
    BRAVE_API_KEY: process.env.BRAVE_API_KEY || "",
  },
  verbose: true,
})
@llmProvider("openai", { apiKey: process.env.LLM_API_KEY })
@agent({
  name: "ResearcherAgent",
  role: "Research Specialist",
  description: "Finds and analyzes information using Brave Search.",
  objective: "Provide accurate, up-to-date information using tools.",
  model: process.env.LLM_API_MODEL!,
  temperature: 0.2,
})
class ResearcherAgent extends Agent {}

@agent({
  name: "SummarizerAgent",
  role: "Summarizer",
  description: "Summarizes research findings.",
  objective: "Create concise summaries of research results.",
  model: process.env.LLM_API_MODEL!,
  temperature: 0.4,
})
class SummarizerAgent extends Agent {}

@agent({
  name: "ManagerAgent",
  role: "Manager",
  description: "Delegates tasks to team members.",
  objective: "Coordinate the team to solve complex tasks.",
  model: process.env.LLM_API_MODEL!,
  temperature: 0.7,
})
class ManagerAgent extends Agent {}

@llmProvider("openai", { apiKey: process.env.LLM_API_KEY })
@forge()
class TeamWithMCPExample {
  static forge: AgentForge;

  static async run() {
    const agentClasses = [ManagerAgent, ResearcherAgent, SummarizerAgent];
    await readyForge(TeamWithMCPExample, agentClasses);

    const team = TeamWithMCPExample.forge
      .createTeam(
        "ManagerAgent",
        "Research Team",
        "A team with MCP-powered research"
      )
      .addAgent(TeamWithMCPExample.forge.getAgent("ResearcherAgent")!)
      .addAgent(TeamWithMCPExample.forge.getAgent("SummarizerAgent")!);
    const result = await team.run(
      "What are the latest breakthroughs in quantum computing? Summarize the findings.",
      { verbose: true }
    );
    console.log(result.output);
  }
}

TeamWithMCPExample.run();

7. RAG (Retrieval-Augmented Generation) with ChromaDB

Agent Forge provides built-in RAG capabilities using ChromaDB, allowing agents to retrieve and use information from indexed documents. This enables agents to answer questions based on your specific knowledge base.

Prerequisites

ChromaDB Server: Start ChromaDB using Docker:
```
docker run -p 8000:8000 chromadb/chroma
```
Install Dependencies: ChromaDB is automatically included when you install Agent Forge.

Setting Up RAG

1. Index Your Documents

First, create and index your documents using the DocumentIndexer:

import { DocumentIndexer, RAGChromaDbConfig } from "agent-forge";

const ragConfig: RAGChromaDbConfig = {
  collectionName: "company_knowledge_base",
  chromaUrl: "http://localhost:8000",
  chunkSize: 800,
  chunkOverlap: 150,
};

const indexer = new DocumentIndexer(ragConfig);
await indexer.initialize();

// Index a directory of documents
const result = await indexer.indexDirectory("./documents");
console.log(`Indexed ${result.documentsProcessed} documents`);

// Or index specific files
await indexer.indexFiles(["./file1.txt", "./file2.md"]);

// Or index text directly
await indexer.indexText("Your content here", "source-name");

Supported file types:

.txt - Plain text files
.md, .markdown - Markdown files
.json - JSON files (text content extracted recursively)

2. Create RAG-Enabled Agents

Use the @RAGChromaDb decorator to add retrieval capabilities to agents:

import {
  RAGChromaDb,
  agent,
  llmProvider,
  forge,
  readyForge,
} from "agent-forge";
import { Agent, AgentForge, LLMProvider } from "agent-forge";

@RAGChromaDb({
  collectionName: "company_knowledge_base",
  chromaUrl: "http://localhost:8000",
  topK: 3,
  similarityThreshold: 0.3,
})
@agent({
  name: "Knowledge Assistant",
  role: "Knowledge Base Specialist",
  description: "Assistant with access to company knowledge base",
  objective: "Provide accurate information from company documents",
  model: process.env.LLM_API_MODEL!,
  temperature: 0.3,
})
class KnowledgeAssistant extends Agent {}

@llmProvider(process.env.LLM_PROVIDER as LLMProvider, {
  apiKey: process.env.LLM_API_KEY,
})
@forge()
class RAGExample {
  static forge: AgentForge;

  static async run() {
    const agentClasses = [KnowledgeAssistant];
    // readyForge automatically initializes RAG systems
    await readyForge(RAGExample, agentClasses);

    const result = await RAGExample.forge.runAgent(
      "Knowledge Assistant",
      "What is our company's remote work policy?"
    );

    console.log(result.output);
  }
}

RAGExample.run();

3. RAG Teams and Workflows

RAG-enabled agents work seamlessly with teams and workflows:

@RAGChromaDb({
  collectionName: "company_knowledge_base",
  chromaUrl: "http://localhost:8000",
  topK: 5,
  similarityThreshold: 0.2,
})
@agent({
  name: "Research Specialist",
  role: "Research and Analysis Expert",
  description: "Specialist in researching company documents",
  objective: "Conduct thorough research and analysis",
  model: process.env.LLM_API_MODEL!,
  temperature: 0.4,
})
class ResearchSpecialist extends Agent {}

@agent({
  name: "Team Manager",
  role: "Team Coordination Manager",
  description: "Manages team workflow and coordinates responses",
  objective: "Coordinate team members and synthesize expertise",
  model: process.env.LLM_API_MODEL!,
  temperature: 0.6,
})
class TeamManager extends Agent {}

@llmProvider(process.env.LLM_PROVIDER as LLMProvider, {
  apiKey: process.env.LLM_API_KEY,
})
@forge()
class RAGTeam {
  static forge: AgentForge;

  static async run() {
    const agentClasses = [TeamManager, ResearchSpecialist];
    await readyForge(RAGTeam, agentClasses);

    const team = RAGTeam.forge.createTeam(
      "Team Manager",
      "Knowledge Team",
      "Team with access to company knowledge base"
    );
    team.addAgent(RAGTeam.forge.getAgent("Research Specialist")!);

    const result = await team.run(
      "Research our vacation policies and technical documentation standards",
      { verbose: true }
    );

    console.log(result.output);
  }
}

RAGTeam.run();

RAG Configuration Options

The @RAGChromaDb decorator accepts the following configuration:

interface RAGChromaDbConfig {
  collectionName: string; // ChromaDB collection name
  chromaUrl?: string; // ChromaDB server URL (default: "http://localhost:8000")
  topK?: number; // Number of documents to retrieve (default: 5)
  similarityThreshold?: number; // Minimum similarity score (default: 0.0)
  chunkSize?: number; // Text chunk size for indexing (default: 1000)
  chunkOverlap?: number; // Chunk overlap size (default: 200)
  maxRetries?: number; // Connection retry attempts (default: 3)
  timeout?: number; // Request timeout in ms (default: 30000)
}

Document Training Script

You can run the included document training example:

# Train documents (index them into ChromaDB)
npm run example:rag-train

# Train documents with increased memory (for large document sets)
npm run example:rag-train-memory

# Run simple RAG example
npm run example:rag-simple

# Run RAG team example
npm run example:rag-team

Troubleshooting Memory Issues:

If you encounter "heap out of memory" errors: 2. Reduce document chunk size in your configuration 3. Process smaller batches of files at a time 4. Ensure you have sufficient system memory available

RAG vs Non-RAG Comparison

RAG-enabled agents have access to your specific knowledge base, while regular agents rely only on their training data:

// RAG-enabled agent - has access to company documents
const ragResponse = await forge.runAgent(
  "Knowledge Assistant",
  "What are our professional development policies?"
);
// Returns specific, accurate information from your documents

// Regular agent - uses general knowledge only
const generalResponse = await forge.runAgent(
  "General Assistant",
  "What are our professional development policies?"
);
// Returns generic advice, not company-specific information

RAG Workflow Features

Document Chunking: Intelligent text splitting with configurable size and overlap
Semantic Search: Retrieves relevant documents using embedding similarity
Error Handling: Graceful fallback when ChromaDB is unavailable
Team Integration: RAG agents work seamlessly in team workflows
Tool Integration: RAG appears as a tool that agents can use when needed

Plugin System

Agent Forge features a powerful plugin architecture with lifecycle hooks that enables you to extend framework functionality and implement cross-cutting concerns like logging, metrics, security, and caching.

Plugin Lifecycle Hooks

Plugins can hook into various points in the framework's execution:

Framework Lifecycle: FRAMEWORK_INITIALIZE, FRAMEWORK_READY, FRAMEWORK_SHUTDOWN
Agent Lifecycle: AGENT_REGISTER, AGENT_BEFORE_RUN, AGENT_AFTER_RUN, AGENT_ERROR
LLM Lifecycle: LLM_BEFORE_REQUEST, LLM_AFTER_REQUEST, LLM_STREAM_START, LLM_STREAM_END
Tool Lifecycle: TOOL_BEFORE_EXECUTE, TOOL_AFTER_EXECUTE, TOOL_ERROR
Team/Workflow Lifecycle: TEAM_BEFORE_RUN, TEAM_AFTER_RUN, WORKFLOW_BEFORE_RUN, WORKFLOW_AFTER_RUN
Logging Lifecycle: LOG_ENTRY_CREATED, LOG_ERROR_OCCURRED, LOG_CRITICAL_OCCURRED

Creating Custom Plugins

To create a custom plugin, extend the Plugin class:

import { Plugin, PluginLifecycleHooks, type PluginHookData } from "agent-forge";

export class SecurityPlugin extends Plugin {
  readonly name = "security";
  readonly version = "1.0.0";
  readonly priority = 90; // Higher numbers run first

  getHooks() {
    return {
      [PluginLifecycleHooks.AGENT_BEFORE_RUN]: this.validateInput.bind(this),
      [PluginLifecycleHooks.TOOL_BEFORE_EXECUTE]:
        this.validateToolCall.bind(this),
    };
  }

  private validateInput(data: PluginHookData): any {
    const { input } = data.payload;

    // Your validation logic here
    if (this.containsSensitiveData(input)) {
      this.log("⚠️ Input contains sensitive data - sanitizing", "warn");
      return { ...data.payload, input: this.sanitizeInput(input) };
    }

    return data.payload;
  }

  private validateToolCall(data: PluginHookData): any {
    const { toolName } = data.payload;

    if (!this.isToolAllowed(toolName)) {
      throw new Error(`Tool ${toolName} is not allowed by security policy`);
    }

    return data.payload;
  }

  // ... implementation details
}

Using Plugins

With Decorators

import { plugin, forge, llmProvider, agent } from "agent-forge";

@plugin(new SecurityPlugin()) // Your custom plugin
@plugin(new LoggingPlugin()) // Your custom logging plugin
@llmProvider("openai", { apiKey: process.env.LLM_API_KEY })
@forge()
class MyApplication {
  static forge: AgentForge;

  static async run() {
    // Initialize framework with plugins
    await MyApplication.forge.initialize();

    // Register agent classes with readyForge
    const agentClasses = [YourAgentClass]; // Replace with your actual agent classes
    await readyForge(MyApplication, agentClasses);

    // ... your application logic

    // Shutdown cleanly
    await MyApplication.forge.shutdown();
  }
}

Programmatically

import { AgentForge } from "agent-forge";

const forge = new AgentForge();

// Register plugins
await forge.registerPlugin(new CustomLoggingPlugin());
await forge.registerPlugin(new CustomMetricsPlugin());

// Initialize framework
await forge.initialize();

// Plugin manager access
const pluginManager = forge.getPluginManager();
const enabledPlugins = pluginManager.getEnabledPlugins();
const loggingPlugin = pluginManager.getPlugin("logging");

Plugin Management

// Get plugin manager
const pluginManager = forge.getPluginManager();

// List all plugins
const allPlugins = pluginManager.getAllPlugins();
const enabledPlugins = pluginManager.getEnabledPlugins();

// Get specific plugin
const customPlugin = pluginManager.getPlugin("custom") as CustomPlugin;

// Enable/disable plugins
const loggingPlugin = pluginManager.getPlugin("logging");
loggingPlugin?.disable();
loggingPlugin?.enable();

// Unregister plugin
await pluginManager.unregisterPlugin("security");

Plugin Use Cases

The plugin architecture enables many powerful use cases:

Development: Debugging, performance profiling, step-through execution
Production: Monitoring, alerting, health checks, SLA tracking
Security: Input validation, output sanitization, access control
Performance: Caching, connection pooling, request batching
Integration: Database logging, webhook notifications, external APIs
Compliance: Audit trails, data retention, privacy controls

Plugin Example

Create custom plugins to extend Agent Forge functionality (see the complete plugin example at `src/examples/plugin-example/):

Security validation and input sanitization
Caching and performance optimization
Custom logging and metrics collection
Plugin management and lifecycle hooks
Integration with teams and workflows

Decorators Reference

@agent(config): Attach agent config to a class.
@tool(ToolClass): Add a tool to an agent. Can be used multiple times to add multiple tools.
@llmProvider(provider, config): Set LLM provider for a class.
@forge(config?): Attach a static AgentForge instance to a class with optional configuration including logging levels.
@plugin(pluginInstance): Register a plugin with the framework.
@a2aServer(options): Expose an agent as an A2A server.
@a2aClient(options): Connect an agent to a remote A2A server.
@MCP(protocol, config): Attach MCP tools to an agent.
@RateLimiter(config): Add rate limiting to an agent's tool usage.
@RAGChromaDb(config): Add RAG (Retrieval-Augmented Generation) capabilities with ChromaDB to an agent.
@Visualizer(): Enable timeline visualization for team runs. When used above @forge and @llmProvider, it will automatically generate an interactive HTML timeline of all agent, manager, and task events after each run.

Usage Example:

import { Visualizer, forge, llmProvider, agent, tool } from "agent-forge";
import { AgentForge, Agent, WebSearchTool } from "agent-forge";

@tool(WebSearchTool)
@agent({
  name: "ManagerAgent",
  role: "Manager",
  description: "Delegates tasks to team members.",
  objective: "Coordinate the team to solve complex tasks.",
  model: process.env.LLM_API_MODEL!,
})
class ManagerAgent extends Agent {}

@llmProvider("openai", { apiKey: process.env.LLM_API_KEY })
@Visualizer()
@forge()
class TeamWithTimeline {
  static forge: AgentForge;
  // ...
}

After running a team, an HTML timeline file will be written to the current directory (e.g., team-run-timeline.html).

Documentation

See the docs/ directory for full documentation, API reference, and advanced usage.
Example projects: src/examples/

Contributing

Contributions are welcome! Please see CONTRIBUTING.md for details.

License

MIT

Agent Forge: Build, orchestrate, and scale AI agents and teams.

Name		Name	Last commit message	Last commit date
Latest commit History 258 Commits
.cursor/rules		.cursor/rules
.github		.github
.yarn/releases		.yarn/releases
docs		docs
src		src
.env.sample		.env.sample
.gitignore		.gitignore
.releaserc.json		.releaserc.json
.yarnrc.yml		.yarnrc.yml
CHANGELOG.md		CHANGELOG.md
CONTRIBUTING.md		CONTRIBUTING.md
LICENSE		LICENSE
README.md		README.md
agentforge.config.json		agentforge.config.json
biome.json		biome.json
package.json		package.json
tsconfig.json		tsconfig.json
yarn.lock		yarn.lock

License

frostlogic-ab/agent-forge

Folders and files

Latest commit

History

Repository files navigation

Agent Forge 🔨

Features

Installation

TypeScript Configuration

Example tsconfig.json

Quick Start

1. Team of Local Agents

Logging Configuration

Basic Logging Configuration

Available Log Levels

Logger Configuration Options

Environment-Specific Examples

2. Workflows: Step-by-Step Task Automation

3. Expose an Agent as a Remote A2A Server

4. Connect to a Remote Agent (A2A Client)

5. Team with a Remote Agent as a Member

5. Using Tools with Agents

Adding Tools with the @tool Decorator

Creating Custom Tools

Tool Requirements

Tool Parameter Types

6. Team with MCP Tool Agent

7. RAG (Retrieval-Augmented Generation) with ChromaDB

Prerequisites

Setting Up RAG

1. Index Your Documents

2. Create RAG-Enabled Agents

3. RAG Teams and Workflows

RAG Configuration Options

Document Training Script

RAG vs Non-RAG Comparison

RAG Workflow Features

Plugin System

Plugin Lifecycle Hooks

Creating Custom Plugins

Using Plugins

With Decorators

Programmatically

Plugin Management

Plugin Use Cases

Plugin Example

Decorators Reference

Documentation

Contributing

License

About

Topics

Resources

License

Contributing

Uh oh!

Stars

Watchers

Forks

Releases 58

Packages 0

Uh oh!

Contributors 5

Uh oh!

Languages

Adding Tools with the `@tool` Decorator

Packages