Getting Started

Getting Started with AgentNexus

Welcome to AgentNexus! This section will guide you through the process of setting up the framework and building your first agent.

What You’ll Learn

Prerequisites

Before you begin, make sure you have:

  • Python 3.8 or higher installed
  • Basic familiarity with Python and async programming concepts
  • Basic understanding of FastAPI (helpful but not required)
  • A development environment set up for Python

Quick Installation

If you’re eager to get started, here’s the quick installation command:

pip install agentnexus

For more detailed installation instructions and options, see the Installation page.

Hello, Agent!

Here’s a minimal example of a AgentNexus agent to give you a taste of the framework:

from fastapi import FastAPI
from agentnexus.base_types import AgentConfig, Capability, ActionType
from agentnexus.action_manager import agent_action
from agentnexus.manifest_generator import AgentManager

# Create agent configuration
hello_agent = AgentConfig(
    name="Hello Agent",
    version="1.0.0",
    description="A simple hello world agent"
)

# Define an agent action
@agent_action(
    agent_config=hello_agent,
    action_type=ActionType.TALK,
    name="Say Hello",
    description="Responds with a greeting"
)
async def say_hello(input_data):
    name = getattr(input_data, "name", "World")
    return {"greeting": f"Hello, {name}!"}

# Set up FastAPI app with agent
app = FastAPI()
agent_manager = AgentManager(base_url="http://localhost:8000")
agent_manager.add_agent(hello_agent)
agent_manager.setup_agents(app)

# Run with: uvicorn main:app --reload

Next Steps

Installation →

Install AgentNexus and set up your development environment.

Basic Concepts →

Learn the fundamental concepts of AgentNexus.