Skip to main content

A lightweight framework for building LLM-powered agents.

Project description

FlatAgents (Python SDK)

Define single-call LLM agents in YAML. Use this package when you want one structured call per agent, with optional MCP tools and profile-driven model configs. For orchestration, install flatmachines separately.

For LLM/machine readers: see MACHINES.md.

Install

pip install flatagents[litellm]
# or
pip install flatagents[aisuite]

Optional extras:

  • flatagents[validation] – JSON schema validation
  • flatagents[metrics] – OpenTelemetry metrics
  • flatagents[orchestration] – installs flatmachines and re-exports its APIs

Quick Start

from flatagents import FlatAgent

agent = FlatAgent(config_file="reviewer.yml")
result = await agent.call(code="...")
print(result.output)

Agent Config (YAML)

spec: flatagent
spec_version: "0.10.0"

data:
  name: code-reviewer
  model: "smart"     # profile name or inline dict
  system: "You are a careful reviewer."
  user: "Review this code: {{ input.code }}"
  output:
    issues: { type: list, items: { type: str } }
    rating: { type: str, enum: [good, needs_work, critical] }

Templates

system and user are Jinja2 templates with:

  • input.* from FlatAgent.call(**input)
  • model.* resolved model config (provider/name/etc)
  • tools and tools_prompt if MCP tools are configured

Output Schema

If data.output is provided, FlatAgents requests JSON mode and parses the response. Invalid JSON falls back to {"_raw": "..."}.

Model Profiles (profiles.yml)

spec: flatprofiles
spec_version: "0.10.0"

data:
  model_profiles:
    fast: { provider: cerebras, name: zai-glm-4.6, temperature: 0.6 }
    smart: { provider: anthropic, name: claude-3-opus-20240229 }
  default: fast
  # override: smart

Resolution order: default → named profile → inline overrides → override.

Python behavior: FlatAgent auto-discovers the nearest profiles.yml next to the config file. If a parent machine passes profiles_dict, it is used only as a fallback (no merging).

Backends

Built-in backends:

  • LiteLLMBackend (default, litellm)
  • AISuiteBackend (aisuite)

Selection order:

  1. backend argument to FlatAgent(...)
  2. data.model.backend
  3. FLATAGENTS_BACKEND env var ("litellm" or "aisuite")
  4. Auto-detect installed backend (prefers litellm)

MCP Tools

Configure MCP in data.mcp and pass a MCPToolProvider implementation. The SDK does not ship a provider; you supply one (e.g., from aisuite.mcp). Tool calls are returned in AgentResponse.tool_calls.

Validation

from flatagents import validate_flatagent_config
warnings = validate_flatagent_config(config)

Logging & Metrics

from flatagents import setup_logging, get_logger
setup_logging(level="INFO")
logger = get_logger(__name__)

Env vars: FLATAGENTS_LOG_LEVEL, FLATAGENTS_LOG_FORMAT, FLATAGENTS_LOG_DIR.

Metrics (OpenTelemetry):

pip install flatagents[metrics]
export FLATAGENTS_METRICS_ENABLED=true

Optional Orchestration

If flatmachines is installed (flatagents[orchestration]), the FlatMachine APIs are re-exported from flatagents for convenience:

from flatagents import FlatMachine

Examples (Repo)

Specs

Source of truth:

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

flatagents-2.2.0.tar.gz (61.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

flatagents-2.2.0-py3-none-any.whl (75.9 kB view details)

Uploaded Python 3

File details

Details for the file flatagents-2.2.0.tar.gz.

File metadata

  • Download URL: flatagents-2.2.0.tar.gz
  • Upload date:
  • Size: 61.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.9

File hashes

Hashes for flatagents-2.2.0.tar.gz
Algorithm Hash digest
SHA256 81c59dcae5aa8148c4e5842f76435f987c0f18d21acb1484a8d36e60a8c19eb0
MD5 1d3ca5e16b88d1bf7d9c87cda1e5337e
BLAKE2b-256 62fd9402b3bea7c8a58f489f985e6015f38611a19a7c02b7b6312f862f31014a

See more details on using hashes here.

File details

Details for the file flatagents-2.2.0-py3-none-any.whl.

File metadata

  • Download URL: flatagents-2.2.0-py3-none-any.whl
  • Upload date:
  • Size: 75.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.9

File hashes

Hashes for flatagents-2.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f7a9121ef05d718c7c3e9ebfb98bd2ac728f874241434fcd25f1b8aa4db890ad
MD5 5fb4fdd92725f9241d016bd02b8c9adc
BLAKE2b-256 de22eb2d9318ffa3b4a0b67001315afc4df214722c863166ca2a8dd8a9182e82

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page