Skip to main content

Prerequisites

Before you begin, ensure you have:
  • Python 3.10+ (3.11+ recommended)
  • Docker & Docker Compose (for infrastructure)
  • Git (for cloning the repository)
  • An LLM API key (Google Gemini recommended for free tier)
We recommend Google Gemini for getting started - it’s free and has generous limits!

Installation

1

Clone the Repository

2

Install uv

uv is a fast Python package manager (10-100x faster than pip):
Already have uv? Run uv self update to get the latest version.
3

Install Dependencies

Or use the Makefile:
No manual venv creation needed! uv sync automatically:
  • Creates .venv if it doesn’t exist
  • Installs all dependencies from pyproject.toml
  • Uses uv.lock for reproducible builds
4

Start Infrastructure

This starts OpenFGA, Jaeger, Prometheus, and Grafana:
Verify services are running:
5

Setup OpenFGA

Initialize the authorization system:
Save the output OPENFGA_STORE_ID and OPENFGA_MODEL_ID - you’ll need them next.
6

Configure Environment

Edit .env with your values:
7

Test the Installation

Run the example client:
You should see the agent responding to queries! 🎉

Verify Installation

Check that all services are accessible:

Your First Request

Let’s send a message to the agent:

Understanding the Response

The agent returns a structured response:
string
The agent’s response text
string
Always “assistant” for agent responses
string
The LLM model used (supports fallback)
object
Token usage statistics for cost tracking
string
OpenTelemetry trace ID for debugging

Next Steps

Configure Authentication

Set up JWT and user management

Add Authorization

Configure fine-grained permissions with OpenFGA

Switch LLM Providers

Use Anthropic, OpenAI, or local models

Deploy to Production

Kubernetes, Helm, and production setup

Troubleshooting

If port 8080 or 8000 is already in use:
Ensure OpenFGA is running:
Verify your API key:
Get a new key from Google AI Studio
Ensure dependencies are installed:
Use uv run <command> to run commands without manual activation.
Need more help? Check the Development Setup guide or ask in GitHub Discussions.

What’s Next?

Now that you have the agent running:
  1. Explore the code - Check out agent.py to see how the LangGraph agent works
  2. Try different models - Follow the Multi-LLM Setup guide
  3. Configure security - Set up proper authentication
  4. Deploy it - Follow the deployment guides
Pro Tip: Star the GitHub repository to stay updated with new features!