Agent Templates

Pre-built AI agent blueprints you can use instantly or customize

Agent Recipes are ready-to-use AI agent blueprints. Think of them like cooking recipes - follow the steps and get reliable results every time.

---

Why Use Recipes?

No Coding Required

Just run them - everything is pre-configured

Battle-Tested

Community-proven patterns that work

Customizable

Adjust variables to fit your needs

---

Quick Start

1. Install PraisonAI

   pip install praisonai
   
2. Set Your API Key

   export OPENAI_API_KEY=your_key_here
   
3. Run a Recipe

   praisonai recipe run research-agent --var topic="AI trends 2024"
   

---

How Recipes Work

Step	What Happens
1. You provide input	Tell the recipe what to work on
2. Agents are created	The blueprint builds specialized workers
3. Tasks execute	Each agent completes their job
4. Tools help	Agents use search, files, etc.
5. You get results	Combined output from all agents

---

Popular Recipes

Research Agent

Searches the web and creates summaries on any topic

praisonai recipe run research-agent --var topic="Your topic"

Video Editor

AI-powered video editing and optimization

praisonai recipe run ai-video-editor --var input=video.mp4

Code Reviewer

Reviews code and suggests improvements

praisonai recipe run code-reviewer --var repo=./myproject

Content Writer

Creates articles, blog posts, and marketing copy

praisonai recipe run content-writer --var topic="Your topic"

---

Recipe Commands

What you want to do	Command
See all recipes	praisonai recipe list
Get recipe details	praisonai recipe info <name>
Run a recipe	praisonai recipe run <name>
Run with options	praisonai recipe run <name> --var key=value
Create your own	praisonai recipe init my-recipe

---

Anatomy of a Recipe

Every recipe is just a folder with a configuration file:

my-recipe/
├── agents.yaml    ← The blueprint
├── tools.py       ← Optional: custom tools
└── README.md      ← Optional: documentation

The agents.yaml File

This is where the magic happens. Here’s a simple example:

framework: praisonai
topic: "{{task}}"

roles:
  researcher:
    role: Research Specialist
    goal: Find accurate information
    tools:
      - internet_search
    tasks:
      research:
        description: "Research {{task}} and provide key findings"
        expected_output: "Summary with sources"

The {{task}} is a variable - you fill it in when running the recipe!

---

Customizing Recipes

Option 1: Change Variables

Most recipes have built-in options you can adjust:

# See what options are available
praisonai recipe info research-agent

# Run with your settings
praisonai recipe run research-agent \
  --var topic="Renewable energy" \
  --var depth="comprehensive"

Option 2: Edit the Blueprint

For bigger changes, modify the agents.yaml file:

1. Find or create a recipe folder
2. Edit the agents.yaml file
3. Run your modified recipe

# agents.yaml - add another agent!
roles:
  researcher:
    role: Researcher
    goal: Find information
    tasks:
      research:
        description: "Research {{topic}}"
  
  writer:  # ← Add this!
    role: Writer
    goal: Write engaging content
    tasks:
      write:
        description: "Write about the research findings"

---

Creating Your Own Recipe

1. Initialize

   praisonai recipe init my-awesome-recipe
   cd my-awesome-recipe
   
2. Edit agents.yaml

   Define your agents and what they should do:

   framework: praisonai
   topic: "{{task}}"
   
   roles:
     helper:
       role: Helpful Assistant
       goal: Complete the user's task
       tasks:
         main:
           description: "{{task}}"
           expected_output: "Task completed successfully"
   
3. Test It

   praisonai recipe run . --var task="Say hello world"
   

---

Recipe Variables

Variables let you customize recipes without editing files:

In the YAML file	How to use it
{{topic}}	--var topic="Your topic"
{{input}}	--var input="file.txt"
{{output}}	--var output="result.txt"

Variable names are flexible - recipe authors can name them anything!

---

Adding Tools to Recipes

Tools give your agents superpowers:

roles:
  agent:
    role: My Agent
    tools:
      - internet_search    # Search the web
      - file_read_tool     # Read files
      - shell_tool         # Run commands

Available Tools

Tool	What it does
internet_search	Search the web for information
file_read_tool	Read files from disk
file_write_tool	Write files to disk
shell_tool	Run terminal commands

Run praisonai tools list to see all available tools!

---

Running Recipes from GitHub

Share and use recipes from anywhere:

# Run directly from GitHub
praisonai recipe run github:MervinPraison/Agent-Recipes/research-agent

# From a specific branch
praisonai recipe run github:MervinPraison/Agent-Recipes/research-agent@main

---

Troubleshooting

Recipe not found

Make sure you’re in the right directory or use the full path:

praisonai recipe run ./my-recipe

Tool not working

Check if the tool is available:

praisonai tools list

Variable not substituted

Make sure you’re using the correct variable name with --var:

praisonai recipe run my-recipe --var topic="My topic"

Need more details

Enable verbose mode to see what’s happening:

praisonai recipe run my-recipe --verbose

---

Best Practices

Start with existing recipes

Browse the recipe library first - someone may have already built what you need!

Keep it simple

Start with one agent, then add more as needed. Simpler is usually better.

Use clear task descriptions

Tell your agents exactly what you want in the task description.

Test incrementally

Test your recipe after each change to catch issues early.

---

Related

Tools

Give your agents more capabilities

Agents

Understand how agents work