@memgrafter/flatagents 0.8.0 → 0.8.3

package/MACHINES.md

@@ -0,0 +1,103 @@
+# FlatAgents + FlatMachines Reference
+
+> **Target: <1000 tokens.** LLM-optimized. See `flatagent.d.ts`, `flatmachine.d.ts`, `profiles.d.ts` for schemas.
+>
+> **Versioning:** All specs and SDKs use lockstep versioning.
+
+## Concepts
+
+**FlatAgent**: Single LLM call. Model + prompts + output schema. No orchestration.
+**FlatMachine**: State machine orchestrating agents. States, transitions, conditions, loops, error handling.
+
+| Need | Use |
+|------|-----|
+| Single LLM call | FlatAgent |
+| Multi-step/branching/retry/errors | FlatMachine |
+| Parallel execution | `machine: [a, b, c]` |
+| Dynamic parallelism | `foreach` |
+| Background tasks | `launch` |
+
+## Model Profiles
+
+```yaml
+# profiles.yml — agents reference by name
+spec: flatprofiles
+spec_version: "0.8.3"
+data:
+  model_profiles:
+    fast: { provider: cerebras, name: zai-glm-4.6, temperature: 0.6 }
+    smart: { provider: anthropic, name: claude-3-opus-20240229 }
+  default: fast        # Fallback
+  # override: smart    # Force all
+```
+
+Agent model field: `"fast"` | `{ profile: "fast", temperature: 0.9 }` | `{ provider: x, name: y }`
+Resolution: default → profile → overrides → override
+
+## State Fields
+
+| Field | Purpose |
+|-------|---------|
+| `type` | `initial` (entry) / `final` (exit+output) |
+| `agent` | Agent to call |
+| `machine` | Machine(s) — string or `[array]` for parallel |
+| `foreach` | Array expr for dynamic parallelism (`as`: item var, `key`: result key) |
+| `launch` / `launch_input` | Fire-and-forget machine(s) |
+| `input` | Map input to agent/machine |
+| `output_to_context` | Map `output.*` to `context.*` |
+| `execution` | `{ type: retry, backoffs: [2,8,16], jitter: 0.1 }` |
+| `on_error` | State name or `{ default: x, ErrorType: y }` |
+| `transitions` | `[{ condition: "expr", to: state }, { to: default }]` |
+| `mode` | `settled` (all) / `any` (first) for parallel |
+| `timeout` | Seconds (0=forever) |
+
+## Patterns
+
+**Execution types**: `default` | `retry` (backoffs, jitter) | `parallel` (n_samples) | `mdap_voting` (k_margin, max_candidates)
+
+**Transitions**: `condition: "context.score >= 8"` with `to: state`. Last without condition = default.
+
+**Loops**: Transition `to: same_state`. Machine has `max_steps` safety.
+
+**Errors**: `on_error: state` or per-type. Context gets `last_error`, `last_error_type`.
+
+**Parallel machines**:
+```yaml
+machine: [review_a, review_b]  # Results keyed by name
+mode: settled  # or "any"
+```
+
+**Foreach**:
+```yaml
+foreach: "{{ context.items }}"
+as: item
+machine: processor
+```
+
+**Launch** (fire-and-forget):
+```yaml
+launch: background_task
+launch_input: { data: "{{ context.data }}" }
+```
+
+## Context Variables
+
+`context.*` (all states), `input.*` (initial), `output.*` (in output_to_context), `item`/`as` (foreach)
+
+## Hooks
+
+`on_machine_start`, `on_machine_end`, `on_state_enter`, `on_state_exit`, `on_transition`, `on_error`, `on_action`
+
+```python
+class MyHooks(MachineHooks):
+    def on_action(self, action: str, context: dict) -> dict:
+        if action == "fetch": context["data"] = api_call()
+        return context
+```
+
+## Persistence
+
+```yaml
+persistence: { enabled: true, backend: local }  # local | memory
+```
+Resume: `machine.execute(resume_from=execution_id)`

package/README.md

@@ -1,221 +1,323 @@
-# FlatAgents TypeScript SDK
+# FlatAgents
 
-TypeScript SDK for FlatAgents - Declarative LLM orchestration with YAML.
+Define LLM agents in YAML. Run them anywhere.
 
-## Installation
+**For LLM/machine readers:** see [MACHINES.md](./MACHINES.md) for comprehensive reference.
 
-```bash
-npm install flatagents
-```
+## Why?
 
-## Quick Start
+- **Composition over inheritance** — compose stateless agents and checkpointable machines
+- **Compact structure** — easy for LLMs to read and generate
+- **Simple hook interfaces** — escape hatches without complexity; webhook ready
+- **Inspectable** — every agent and machine is readable config
+- **Language-agnostic** — reduce code in any particular runtime
+- **Common TypeScript interface** — single schema for agents, single schema for machines
+- **Limitations** — machine topologies can get complex at scale
 
-### Single Agent Call
+*Inspired by Kubernetes manifests and character card specifications.*
 
-```typescript
-import { FlatAgent } from 'flatagents';
+## Versioning
 
-const agent = new FlatAgent('agent.yml');
-const result = await agent.call({ query: "Hello World" });
-console.log(result.output);
-```
+All specs (`flatagent.d.ts`, `flatmachine.d.ts`, `profiles.d.ts`) and SDKs (Python, JS) use **lockstep versioning**. A single version number applies across the entire repository.
 
-### State Machine Execution
+## Core Concepts
+
+Use machines to write flatagents and flatmachines, they are designed for LLMs.
 
-```typescript
-import { FlatMachine } from 'flatagents';
+| Term | What it is |
+|------|------------|
+| **FlatAgent** | A single LLM call: model + prompts + output schema |
+| **FlatMachine** | A state machine that orchestrates multiple agents, actions, and state machines |
 
-const machine = new FlatMachine({
-  config: 'machine.yml',
-  hooks: customHooks,
-  persistence: new MemoryBackend()
-});
+Use FlatAgent alone for simple tasks. Use FlatMachine when you need multi-step workflows, branching, or error handling.
+
+## Examples
 
-const result = await machine.execute({ input: "Hello" });
-console.log(result);
+| Example | What it demonstrates |
+|---------|---------------------|
+| [helloworld](./sdk/examples/helloworld/python) | Minimal setup — single agent, single state machine |
+| [writer_critic](./sdk/examples/writer_critic/python) | Multi-agent loop — writer drafts, critic reviews, iterates |
+| [story_writer](./sdk/examples/story_writer/python) | Multi-step creative workflow with chapter generation |
+| [human-in-the-loop](./sdk/examples/human-in-the-loop/python) | Pause execution for human approval via hooks |
+| [error_handling](./sdk/examples/error_handling/python) | Error recovery and retry patterns at state machine level |
+| [dynamic_agent](./sdk/examples/dynamic_agent/python) | On-the-fly agent generation from runtime context |
+| [character_card](./sdk/examples/character_card/python) | Loading agent config from character card format |
+| [mdap](./sdk/examples/mdap/python) | MDAP voting execution — multi-sample consensus |
+| [gepa_self_optimizer](./sdk/examples/gepa_self_optimizer/python) | Self-optimizing prompts via reflection and critique |
+| [research_paper_analysis](./sdk/examples/research_paper_analysis/python) | Document analysis with structured extraction |
+| [multi_paper_synthesizer](./sdk/examples/multi_paper_synthesizer/python) | Cross-document synthesis with dynamic machine launching |
+| [support_triage_json](./sdk/examples/support_triage_json/python) | JSON input/output with classification pipeline |
+| [parallelism](./sdk/examples/parallelism/python) | Parallel machines, dynamic foreach, fire-and-forget launches |
+
+## Quick Start
+
+```bash
+pip install flatagents[all]
 ```
 
-## Core Concepts
+```python
+from flatagents import FlatAgent
+
+agent = FlatAgent(config_file="reviewer.yml")
+result = await agent.call(query="Review this code...")
+print(result.output)
+```
 
-### FlatAgent
-A single LLM call configured in YAML:
+## Example Agent
 
+**reviewer.yml**
 ```yaml
 spec: flatagent
-spec_version: "1.0"
+spec_version: "0.8.2"
+
 data:
-  name: my_agent
-  model:
-    name: gpt-4o-mini
-    provider: openai
-  system: "You are a helpful assistant."
-  user: "{{ input.query }}"
+  name: code-reviewer
+
+  model: "smart-expensive"  # Reference profile from profiles.yml
+
+  system: |
+    You are a senior code reviewer. Analyze code for bugs,
+    style issues, and potential improvements.
+
+  user: |
+    Review this code:
+    {{ input.code }}
+
   output:
-    response:
+    issues:
+      type: list
+      items:
+        type: str
+      description: "List of issues found"
+    rating:
       type: str
-      description: "The response"
+      enum: ["good", "needs_work", "critical"]
+      description: "Overall code quality"
 ```
 
-### FlatMachine
-A state machine that orchestrates agents:
+**What the fields mean:**
 
-```yaml
-spec: flatmachine
-spec_version: "1.0"
-data:
-  name: my_workflow
-  context:
-    result: ""
-  states:
-    initial:
-      type: initial
-      agent: agent.yml
-      transitions:
-        - to: final
-    final:
-      type: final
-      output:
-        result: "{{ context.result }}"
-```
+- **spec/spec_version** — Format identifier and version
+- **data.name** — Agent identifier
+- **data.model** — Profile name, inline config, or profile with overrides
+- **data.system** — System prompt (sets behavior)
+- **data.user** — User prompt template (uses Jinja2, `{{ input.* }}` for runtime values)
+- **data.output** — Structured output schema (the runtime extracts these fields)
 
-## Key Features
+## Model Profiles
 
-### Parallel Execution
+Centralize model configurations in `profiles.yml` and reference them by name:
+
+**profiles.yml**
 ```yaml
-states:
-  parallel_review:
-    machine: [legal_review, tech_review, finance_review]
-    transitions:
-      - to: synthesize
+spec: flatprofiles
+spec_version: "0.8.2"
+
+data:
+  model_profiles:
+    fast-cheap:
+      provider: cerebras
+      name: zai-glm-4.6
+      temperature: 0.6
+      max_tokens: 2048
+
+    smart-expensive:
+      provider: anthropic
+      name: claude-3-opus-20240229
+      temperature: 0.3
+      max_tokens: 4096
+
+  default: fast-cheap      # Fallback when agent has no model
+  # override: smart-expensive  # Uncomment to force all agents
 ```
 
-### Dynamic Parallelism (Foreach)
+**Agent usage:**
 ```yaml
-states:
-  process_all:
-    foreach: "{{ context.documents }}"
-    as: doc
-    machine: processor.yml
-    transitions:
-      - to: aggregate
+# String shorthand — profile lookup
+model: "fast-cheap"
+
+# Profile with overrides
+model:
+  profile: "fast-cheap"
+  temperature: 0.9
+
+# Inline config (no profile)
+model:
+  provider: openai
+  name: gpt-4
+  temperature: 0.3
 ```
 
-### Retry with Backoff
+Resolution order (low → high): default profile → named profile → inline overrides → override profile
+
+## Output Types
+
 ```yaml
-states:
-  robust_call:
-    agent: agent.yml
-    execution:
-      type: retry
-      backoffs: [2, 8, 16, 35]
-      jitter: 0.1
+output:
+  answer:      { type: str }
+  count:       { type: int }
+  score:       { type: float }
+  valid:       { type: bool }
+  raw:         { type: json }
+  items:       { type: list, items: { type: str } }
+  metadata:    { type: object, properties: { key: { type: str } } }
 ```
 
-### Conditional Transitions
-```yaml
-states:
-  check_result:
-    agent: evaluator.yml
-    transitions:
-      - condition: "context.score >= 8"
-        to: success
-      - to: retry
+Use `enum: [...]` to constrain string values.
+
+## Multi-Agent Workflows
+
+For orchestration, use FlatMachine ([full docs in MACHINES.md](./MACHINES.md)):
+
+```python
+from flatagents import FlatMachine
+
+machine = FlatMachine(config_file="workflow.yml")
+result = await machine.execute(input={"query": "..."})
 ```
 
-### Error Handling
-```yaml
-states:
-  risky_state:
-    agent: agent.yml
-    on_error: error_handler
+FlatMachine provides: state transitions, conditional branching, loops, retry with backoff, and error recovery—all in YAML.
+
+## Features
+
+- Checkpoint and restore
+- Python SDK (TypeScript SDK in progress)
+- [MACHINES.md](./MACHINES.md) — LLM-optimized reference docs
+- Decider agents and machines
+- On-the-fly agent and machine definitions
+- Webhook hooks for remote state machine handling
+- Metrics and logging
+- Error recovery and exception handling at the state machine level
+- Parallel machine execution (`machine: [a, b, c]`)
+- Dynamic parallelism with `foreach`
+- Fire-and-forget launches for background tasks
+
+## Planned
+
+- Distributed execution — cross-network machine peering, inter-machine strategies
+- SQL persistence backend
+- TypeScript SDK
+- `max_depth` config to limit machine launch nesting
+- Checkpoint pruning to prevent storage explosion
+- `$root/` path prefix — resolve agent/machine refs from workspace root, not config dir
+- Input size validation — warn when prompt exceeds model context window
+- Serialization warnings — flag non-JSON-serializable context values before checkpoint
+
+## Specs
+
+TypeScript definitions are the source of truth:
+- [`flatagent.d.ts`](./flatagent.d.ts)
+- [`flatmachine.d.ts`](./flatmachine.d.ts)
+- [`profiles.d.ts`](./profiles.d.ts)
+
+## Python SDK
+
+```bash
+pip install flatagents[litellm]
 ```
 
-### Persistence & Checkpointing
-```yaml
-persistence:
-  enabled: true
-  backend: local  # or memory
+### LLM Backends
+
+```python
+from flatagents import LiteLLMBackend, AISuiteBackend
+
+# LiteLLM (default)
+agent = FlatAgent(config_file="agent.yml")
+
+# AISuite
+backend = AISuiteBackend(model="openai:gpt-4o")
+agent = FlatAgent(config_file="agent.yml", backend=backend)
 ```
 
-## Hooks
+### Hooks
+
+Extend machine behavior with Python hooks:
+
+```python
+from flatagents import FlatMachine, MachineHooks
 
-Extend with custom logic:
+class CustomHooks(MachineHooks):
+    def on_state_enter(self, state: str, context: dict) -> dict:
+        context["entered_at"] = time.time()
+        return context
 
-```typescript
-class CustomHooks implements MachineHooks {
-  async onStateEnter(state: string, context: any) {
-    console.log(`Entering ${state}`);
-    return context;
-  }
+    def on_action(self, action: str, context: dict) -> dict:
+        if action == "fetch_data":
+            context["data"] = fetch_from_api()
+        return context
 
-  async onError(state: string, error: Error, context: any) {
-    console.error(`Error in ${state}:`, error);
-    return "recovery_state";
-  }
-}
+machine = FlatMachine(config_file="machine.yml", hooks=CustomHooks())
 ```
 
-## MCP Integration
+**Available hooks**: `on_machine_start`, `on_machine_end`, `on_state_enter`, `on_state_exit`, `on_transition`, `on_error`, `on_action`
+
+### Execution Types
 
 ```yaml
-data:
-  mcp:
-    servers:
-      filesystem:
-        command: "npx"
-        args: ["@modelcontextprotocol/server-filesystem", "/path/to/files"]
-    tool_filter:
-      allow: ["filesystem:*"]
+execution:
+  type: retry              # retry | parallel | mdap_voting
+  backoffs: [2, 8, 16, 35] # Seconds between retries
+  jitter: 0.1              # ±10% random variation
 ```
 
-## Examples
+| Type | Use Case |
+|------|----------|
+| `default` | Single call |
+| `retry` | Rate limit handling with backoff |
+| `parallel` | Multiple samples (`n_samples`) |
+| `mdap_voting` | Consensus voting (`k_margin`, `max_candidates`) |
 
-- **Helloworld**: Simple agent that builds "Hello World" one character at a time
-- **Parallelism**: Machine arrays, foreach loops, and fire-and-forget patterns
-- **Human-in-the-loop**: Custom hooks for interactive approval flows
-- **Peering**: Parent-child machine communication with result backends
+### Schema Validation
 
-## API Reference
+```python
+from flatagents import validate_flatagent_config, validate_flatmachine_config
 
-### FlatAgent
-```typescript
-class FlatAgent {
-  constructor(config: AgentConfig | string);
-  async call(input: Record<string, any>): Promise<{content: string, output: any}>;
-}
+warnings = validate_flatagent_config(config)
+warnings = validate_flatmachine_config(config)
 ```
 
-### FlatMachine
-```typescript
-class FlatMachine {
-  constructor(options: MachineOptions);
-  async execute(input?: Record<string, any>): Promise<any>;
-  async resume(executionId: string): Promise<any>;
-}
-```
+### Logging & Metrics
 
-### Execution Types
-- `DefaultExecution`: Simple single execution
-- `RetryExecution`: Retry with exponential backoff
+```python
+from flatagents import setup_logging, get_logger
+
+setup_logging(level="INFO")  # Respects FLATAGENTS_LOG_LEVEL env var
+logger = get_logger(__name__)
+```
 
-### Persistence Backends
-- `MemoryBackend`: In-memory storage
-- `LocalFileBackend`: File-based with atomic writes
+**Env vars**: `FLATAGENTS_LOG_LEVEL` (`DEBUG`/`INFO`/`WARNING`/`ERROR`), `FLATAGENTS_LOG_FORMAT` (`standard`/`json`/`simple`)
 
-## Testing
+For OpenTelemetry metrics:
 
 ```bash
-npm test
-npm run typecheck
+pip install flatagents[metrics]
+export FLATAGENTS_METRICS_ENABLED=true
 ```
 
-## Building
+Metrics are enabled by default and print to stdout every 5s. Redirect to file or use OTLP for production:
 
 ```bash
-npm run build
-npm run dev  # watch mode
+# Metrics print to stdout by default
+python your_script.py
+
+# Save to file
+python your_script.py >> metrics.log 2>&1
+
+# Disable if needed
+FLATAGENTS_METRICS_ENABLED=false python your_script.py
+
+# Send to OTLP collector for production
+OTEL_METRICS_EXPORTER=otlp \
+OTEL_EXPORTER_OTLP_ENDPOINT=http://localhost:4317 \
+python your_script.py
 ```
 
-## License
+**Env vars for metrics**:
 
-MIT
+| Variable | Default | Purpose |
+|----------|---------|---------|
+| `FLATAGENTS_METRICS_ENABLED` | `true` | Enable OpenTelemetry metrics |
+| `OTEL_METRICS_EXPORTER` | `console` | `console` (stdout) or `otlp` (production) |
+| `OTEL_EXPORTER_OTLP_ENDPOINT` | — | OTLP collector endpoint |
+| `OTEL_METRIC_EXPORT_INTERVAL` | `5000` / `60000` | Export interval in ms (5s for console, 60s for otlp) |
+| `OTEL_SERVICE_NAME` | `flatagents` | Service name in metrics |

package/package.json

@@ -1,11 +1,26 @@
 {
   "name": "@memgrafter/flatagents",
-  "version": "0.8.0",
+  "version": "0.8.3",
   "description": "TypeScript SDK for FlatAgents - Declarative LLM orchestration with YAML",
   "main": "dist/index.js",
+  "module": "dist/index.mjs",
   "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": {
+        "import": "./dist/index.d.mts",
+        "require": "./dist/index.d.ts"
+      },
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    }
+  },
   "files": [
-    "dist"
+    "dist",
+    "schemas",
+    "MACHINES.md",
+    "AGENTS.md",
+    "CLAUDE.md"
   ],
   "scripts": {
     "build": "tsup",

package/schemas/README.md

@@ -0,0 +1,11 @@
+# Specification Static Assets
+
+**IMPORTANT: The canonical specs are in the repo root.**
+
+* `*.d.ts` - copied from canonical spec at repo.
+* `*.slim.d.ts` - No comments, less context.
+* `*.schema.json` - Automated json conversion.
+
+These assets are included here for easy availability for machines or to copy to SDKs.
+
+It is recommended to directly regenerate these assets in your sdk release with `/scripts/generate-spec-assets.sh`