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-1.2.0.tar.gz (60.1 kB view details)

Uploaded Source

Built Distribution

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

flatagents-1.2.0-py3-none-any.whl (73.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for flatagents-1.2.0.tar.gz
Algorithm Hash digest
SHA256 0cc2f48155ec341e41da01f4c83275f5fc42f31198f3c1a4617a0d9e8cfb2aa8
MD5 b58c481893f90e09e2508eb59aaf1737
BLAKE2b-256 bab14d273786aa7716f2cff48a095aaf7df99095302b7ac653aceaf309ee0b33

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for flatagents-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4083a37f665885a35f5d814364f9dbd593dfa88aafacc77e4d1d47f069005db3
MD5 b5425735fb743ad1797e30dab6753305
BLAKE2b-256 8b6f2600ed3e46715d0622041ad09bb10e704ef261274be35dff6e3f26a589da

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