Skip to main content

Agentic Context Engineering utilities for OpenAI Agents.

Project description

Agentic Context Engineering (ACE)

Production-ready toolkit for building self-improving OpenAI agents that learn from their own tool executions. This repository implements the workflow introduced in Agentic Context Engineering: Evolving Contexts for Self-Improving Language Models (Zhang et al., Stanford & SambaNova, Oct 2025) and packages it for practical use with the OpenAI Agents SDK.


Why ACE?

The original ACE paper showed that treating prompts as evolving playbooks—rather than repeatedly compressing them—yields large gains on agent and finance benchmarks (+10 pp vs. strong baselines) while cutting adaptation cost and latency. Two chronic issues in previous prompt optimizers were called out:

  • Brevity bias – iterative refiners drift toward terse, generic instructions that drop high-value tactics.
  • Context collapse – monolithic rewrites can suddenly shrink a carefully curated context to a few lines, erasing institutional knowledge.

ACE solves this by splitting responsibility across three lightweight roles:

Component Responsibility Effect
Generator Execute the task with current context surfaces success/failure traces
Reflector Diagnose trajectories, extract concrete lessons preserves detail, avoids collapse
Curator Merge lessons as delta bullets, deduplicate semantically keeps contexts structured and scalable

Each insight is a bullet with metadata (usage counts, timestamps, origin tool). Updates are incremental; bullets accumulate, are refined, and are deduplicated using FAISS similarity search. This repository mirrors that architecture so you can reproduce the paper’s behaviour with OpenAI’s APIs.


Repository Tour

  • ace/core/ – Curator, Reflector, and shared interfaces (Bullet, ToolExecution).
  • ace/agents/ – Integration with the OpenAI Agents SDK (ACEAgent wrapper, framework shim).
  • ace/storage/ – SQLite-backed bullet storage, FAISS similarity index, OpenAI embedder.
  • examples/ – Standalone demos:
    • simple_test.py exercises each ACE component in isolation.
    • weather_agent.py shows ACE wrapped around an OpenAI Agent with reactive tool use.
  • scripts/manage_storage.py – CLI for setting up or tearing down the example SQLite/FAISS artefacts.

Quick Start

Prerequisites

  • Python ≥ 3.10
  • uv (recommended) or plain pip
  • OpenAI API key with access to your chosen models

Installation

  1. Clone and enter the repo
    git clone https://github.com/fulkerson-advisors/agentic-context-engineering
    cd ace
    
  2. Sync dependencies
    uv sync
    
  3. Configure environment variables
    cp .env.example .env
    # edit .env with your OpenAI API key and models
    
  4. (Optional) Activate the environment
    source .venv/bin/activate
    
    or prefix commands with uv run.

Storage Management

ACE persists two artefact types:

  • SQLite (*.db) – canonical bullet metadata: content, category, tool name, stats.
  • FAISS (*.faiss, *.faiss.meta) – semantic index used for deduplication and retrieval.

Use the helper script to manage the example files:

# Create the default example databases and FAISS indices
uv run python scripts/manage_storage.py setup

# Remove them again
uv run python scripts/manage_storage.py teardown

Custom paths are supported:

uv run python scripts/manage_storage.py setup \
  --db tmp/my_agent.db \
  --faiss tmp/my_agent.faiss \
  --dimension 3072 \
  --overwrite

Note: embeddings now live only inside the FAISS index. If you delete the .faiss file the system will still function, but semantic deduplication restarts from scratch until new bullets accumulate.

To inspect what’s stored:

  • SQLite: sqlite3 examples/weather_agent.db.tables, .schema bullets, SELECT * FROM bullets;
  • FAISS: in Python:
    from ace.storage.faiss_index import FAISSVectorIndex
    index = FAISSVectorIndex(dimension=1536, index_path="examples/weather_agent.faiss")
    print(index.index.ntotal)
    

Running the Examples

Ensure storage artefacts exist (manage_storage.py setup) and your .env contains a valid OPENAI_API_KEY.

  1. Core component smoke test

    uv run python examples/simple_test.py
    

    Demonstrates reflective learning and FAISS deduplication without the Agents SDK.

  2. Weather agent with OpenAI Agents SDK

    uv run python examples/weather_agent.py
    

    Shows the full Generator→Reflector→Curator loop as the agent encounters erroneous tool calls, learns ACE bullets, and improves on subsequent queries.


Configuration Reference

.env.example documents the supported variables:

Variable Purpose Default behaviour
OPENAI_API_KEY Required for all OpenAI calls
OPENAI_MODEL Default generation/reflection model Pass-through unless specialised overrides are set
OPENAI_EMBEDDING_MODEL Embedding endpoint Falls back to text-embedding-3-small if unset or non-embedding
OPENAI_REFLECTOR_MODEL Reflector override Falls back to OPENAI_MODEL or gpt-4.1-mini

Override per-instance by passing model= when creating OpenAIEmbedder or OpenAIReflector.


Extensibility

ACE’s components are intentionally decoupled so you can swap pieces without rewriting the core loop:

  • Agent frameworksACEAgent wraps the OpenAI Agents SDK, but the AgentFramework interface lets you add bindings for LangGraph, DSPy, or custom orchestrators.
  • Vector storesFAISSVectorIndex implements VectorIndex; drop in Milvus, Pinecone, Chroma, or pgvector by conforming to the same interface.
  • Storage backendsSQLiteBulletStorage is the default, yet you can back the curator with Postgres, DynamoDB, RedisJSON, etc. by subclassing BulletStorage.

This modularity keeps ACE adaptable as your stack evolves.


Testing & Packaging

  • Run the test suite (test extra optional but recommended):
    uv sync --extra test
    uv run pytest
    
  • Build distributables for PyPI:
    uv build
    
  • Publish after creating a token on PyPI (or TestPyPI):
    UV_PUBLISH_TOKEN=pypi-<token> uv publish
    
  • Install the library directly from PyPI (after publishing):
    uv pip install agentic-context-engineering
    

Using ACE After Installation

  1. Install and configure credentials
    uv pip install agentic-context-engineering
    export OPENAI_API_KEY=sk-...
    # optionally set OPENAI_MODEL / OPENAI_EMBEDDING_MODEL / OPENAI_REFLECTOR_MODEL
    
  2. Create the core components
    from ace import (
        Curator,
        OpenAIReflector,
        SQLiteBulletStorage,
        FAISSVectorIndex,
        OpenAIEmbedder,
        ACEAgent,
    )
    
    storage = SQLiteBulletStorage("my_agent.db")
    embedder = OpenAIEmbedder()
    vector_index = FAISSVectorIndex(embedder.dimension(), "my_agent.faiss")
    curator = Curator(storage, vector_index, embedder)
    reflector = OpenAIReflector()
    
  3. Wire an OpenAI Agent (optional but recommended)
    from agents import Agent
    
    agent = Agent(
        model="gpt-4.1-mini",
        instructions="Handle user questions using the available tools.",
        tools=[...],  # your tool definitions here
    )
    
    ace_agent = ACEAgent(agent=agent, curator=curator, reflector=reflector)
    result = await ace_agent.run("Plan tomorrow's meetings.")
    
  4. Manual integration (custom frameworks)
    • Call OpenAIReflector.reflect(...) with a ToolExecution to generate insights.
    • Feed the returned bullets into Curator.add_bullets(...).
    • Retrieve guidelines with Curator.get_relevant_bullets(...) and format them via Curator.format_bullets_for_prompt(...).

Project Status & Roadmap

  • ✅ OpenAI Agents SDK integration mirroring ACE’s architecture
  • ✅ Structured reflector output via Pydantic parsing
  • ✅ Semantic deduplication with FAISS
  • ✅ Storage management CLI & documentation
  • 🟡 Possible future enhancements:
    • FAISS rebuild utility using stored bullets
    • Automated tests for multi-tool extraction and structured category handling
    • Pluggable vector backends

Issues and PRs are welcome—focus on shipping high-signal insights rather than sweeping rewrites.


License

MIT © 2025 ACE contributors. See LICENSE for details.

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

agentic_context_engineering-0.1.1.tar.gz (24.2 kB view details)

Uploaded Source

Built Distribution

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

agentic_context_engineering-0.1.1-py3-none-any.whl (20.6 kB view details)

Uploaded Python 3

File details

Details for the file agentic_context_engineering-0.1.1.tar.gz.

File metadata

File hashes

Hashes for agentic_context_engineering-0.1.1.tar.gz
Algorithm Hash digest
SHA256 c86313e9661a7b2447de1e897bdb745f76d957c3ed06f253e38f96b405d2223a
MD5 f7bca19f5ea71089db4ab685ccddeff6
BLAKE2b-256 d9d04a25bd4b868a8b10bd318afaae45f95da8905d272535ba01855abb524dbe

See more details on using hashes here.

File details

Details for the file agentic_context_engineering-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for agentic_context_engineering-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 0dee6447fc5f9d3385d354d87a600ce91eab3a94b553909d51e60ba96fb98862
MD5 6ad4d8c04a24d912d0d8e9f27e393138
BLAKE2b-256 12712620a4212d5ad4b74adc490afb715da38d97446f2c1eaaa8c9752cfd7a6c

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