Skip to main content

Universal configurable AI agent framework — production-grade, YAML-driven, open-source ready.

Project description

koboi-agent

Configurable AI agent framework. YAML-driven config, async Python 3.10+, multi-provider LLM (OpenAI, Anthropic, Cloudflare).

Features

  • Multi-provider LLM: OpenAI, Anthropic, Cloudflare Workers AI
  • YAML-driven config with ${ENV_VAR} interpolation
  • Built-in tools: calculator, filesystem, shell, web, memory, search, git, subagent, task
  • Hook lifecycle: 15 event types for logging, guardrails, telemetry
  • RAG pipeline: chunking (fixed/sentence/paragraph/semantic), retrieval (keyword/semantic/hybrid), augmentation
  • Guardrails: input/output validation, rate limiting, approval workflows, policy engine
  • Multi-agent orchestration: keyword/LLM/hybrid routing, sequential/parallel execution
  • Context management: truncation, smart truncation, key facts, sliding window
  • Sandboxed execution: pluggable passthrough/restricted backends (per-session workdir, network/rlimit isolation)
  • MCP client (stdio + HTTP) and server support
  • HTTP/SSE server & jobs: koboi serve — interactive SSE chat (HITL) + autonomous background jobs; API keys, ownership, idempotency, durable resume
  • Evaluation: BFCL, GAIA, SWE-bench, RAGAS, DeepEval scorers
  • Terminal UI (Textual): chat, command palette, diff view, session management

Quickstart

Install

pip install -e ".[dev,tui]"

Set your API key

cp .env.example .env
# Edit .env and set OPENAI_API_KEY

Run the CLI

koboi chat configs/simple_chat.yaml

Run programmatically

import asyncio
from koboi import KoboiAgent

async def main():
    async with KoboiAgent.from_config("configs/simple_chat.yaml") as agent:
        result = await agent.run("What is 2 + 2?")
        print(result.content)

asyncio.run(main())

Serving (HTTP/SSE)

Run koboi as a stateless HTTP service: interactive SSE chat (with human-in-the-loop approvals) and autonomous background jobs (durable resume). Requires the [api] extra.

pip install -e ".[api]"
koboi keys create                               # mint an API key (Bearer auth)
koboi serve configs/server_deploy.yaml --host 0.0.0.0 --port 8080

Then:

# interactive SSE chat (stream tokens + HITL approvals)
curl -N -H "Authorization: Bearer $KEY" -H "Content-Type: application/json" \
  -d '{"message":"What is 2+2?"}' http://localhost:8080/v1/chat/stream

# autonomous job (202 + poll / SSE replay)
curl -X POST -H "Authorization: Bearer $KEY" -H "Content-Type: application/json" \
  -d '{"message":"Summarize the Q3 report"}' http://localhost:8080/v1/jobs

Two paths, same composition: koboi serve <config> (built-in) or create_app(config, extra_tools=..., extra_hooks=..., approval_handler=...) (customize by code). See configs/server_simple.yaml / configs/server_deploy.yaml, koboi/server/CLAUDE.md, and docs/rest-sse-requirements.md. Self-host deploy via the bundled Dockerfile + docker-compose.yml (Cloudflare Tunnel).

Container customization (3 tiers)

The published image (ghcr.io/hedypamungkas/koboi-agent:<version>) is a base layer — all three customization paths work without rebuilding koboi:

  • Mount a YAML configdocker run -e KOBOI_CONFIG=/app/agent.yaml -v agent.yaml:/app/agent.yaml … (built-in path, zero code).
  • Mount an extensions dirdocker run -e KOBOI_EXTENSIONS_DIR=/app/ext -v ext/:/app/ext … (custom tools / RAG retrievers via tools.custom / rag.custom_modules; the dir is auto-added to sys.path).
  • Derive a new imageFROM ghcr.io/hedypamungkas/koboi-agent:<version> for full create_app(extra_tools=…, extra_routes=…) composition.

See examples/docker/ for runnable, LLM-free proofs of each tier.

Configuration

Agents are configured via YAML. Key sections:

agent:
  name: "my-agent"
  system_prompt: "You are helpful."
  max_iterations: 10
  mode: "chat"  # chat | plan | act | auto | yolo

llm:
  provider: "openai"        # openai | anthropic | cloudflare
  model: "gpt-4o-mini"
  api_key: "${OPENAI_API_KEY}"
  base_url: "${OPENAI_BASE_URL:}"

tools:
  builtin: [calculator, web_search, memory_store, memory_recall]
  custom:
    - module: "my_tools"

context:
  strategy: "sliding_window"  # noop | truncation | smart_truncation | key_facts | sliding_window
  max_context_tokens: 8000

rag:
  enabled: true
  chunker: "paragraph"       # fixed | sentence | paragraph
  retriever: "keyword"       # keyword | semantic | hybrid
  top_k: 10
  documents:
    - path: "./data/sample/product_catalog.md"

guardrails:
  input:
    max_length: 10000
  rate_limit:
    max_calls_per_minute: 20

harness:
  doom_loop:
    consecutive_identical_threshold: 3
  telemetry: true
  carryover: true

See configs/ for full examples and .claude/skills/yaml-config.md for the complete schema.

Testing

pytest                        # all tests
pytest tests/test_config.py   # single file
pytest -k "hook"              # by keyword
pytest --cov=koboi            # with coverage

Examples

examples/ contains 32 numbered scripts covering every feature, plus server_built_in.py / server_customize.py for HTTP serving:

Range Features
01-04 Basic chat and tool use
05-08 Context management and RAG
09-10 MCP client/server
11-14 Policy, hooks, skills, custom tools
15-16 Multi-agent orchestration
17 Anthropic provider
18-20 Harness (telemetry, doom loop, carryover)
21-24 Evaluation, production setup, SWE-bench, config-driven orchestration
25-28 Subagent delegation, task management, benchmarks, custom RAG
29-32 Skills (enhanced), eval-test, tool selection, sandbox + resume
server_* koboi serve (built-in) and create_app() (customize)

Run any example:

python examples/01_simple_chat.py              # automatic mode
python examples/01_simple_chat.py -m interactive  # interactive mode

Architecture

For a detailed architecture overview (agent loop lifecycle, hook system, tool pipeline, extension points), see docs/architecture.md.

KoboiAgent (facade.py) is the single entry point. It assembles:

  • AgentCore (loop.py) -- async agent loop
  • RetryClient (client.py) -- LLM HTTP transport with retry
  • ToolRegistry (tools/) -- tool registration and execution
  • HookChain (hooks/) -- lifecycle event dispatch (15 events)
  • ContextManager (context/) -- context window strategies
  • AugmentationStrategy (rag/) -- RAG pipeline
  • Guardrails (guardrails/) -- input/output validation
  • PolicyEngine (harness/) -- rule-based tool filtering
  • SkillRegistry (skills/) -- skill discovery
  • ModeManager (modes.py) -- chat/plan/act/auto modes
  • TrustDatabase (trust.py) -- graduated permissions
  • Sandbox (sandbox/) -- passthrough/restricted execution backends (per-session workdir, network/rlimit isolation)
  • StepJournal (journal.py) -- per-iteration step journal for crash/redeploy resume
  • Server (server/) -- FastAPI HTTP/SSE serving (interactive chat + autonomous jobs)
  • Orchestrator (orchestration/) -- multi-agent coordination
  • SubAgentManager (subagent.py) -- parallel sub-agent delegation
  • MCP clients (mcp/) -- external tool servers

All subsystems are configured from a single YAML file via Config (config.py).

License

MIT

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

koboi_agent-0.5.0.tar.gz (509.6 kB view details)

Uploaded Source

Built Distribution

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

koboi_agent-0.5.0-py3-none-any.whl (373.4 kB view details)

Uploaded Python 3

File details

Details for the file koboi_agent-0.5.0.tar.gz.

File metadata

  • Download URL: koboi_agent-0.5.0.tar.gz
  • Upload date:
  • Size: 509.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for koboi_agent-0.5.0.tar.gz
Algorithm Hash digest
SHA256 21957027fc6bf231ff08965cbf9b6e230599eb5ef07d99d5c05b8cd7c8e419bf
MD5 ed2ecc0b4757aa68e42313b05b852b05
BLAKE2b-256 dd6d127351253c717461d283f5378e245fd5d3ff38cad815c2ba7e5645ae4320

See more details on using hashes here.

Provenance

The following attestation bundles were made for koboi_agent-0.5.0.tar.gz:

Publisher: release.yml on hedypamungkas/koboi-agent

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file koboi_agent-0.5.0-py3-none-any.whl.

File metadata

  • Download URL: koboi_agent-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 373.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for koboi_agent-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b72b7ce03c7405c8695c8aacc3974367ddc7fb54360c8316a88484488df5878d
MD5 5392ad33057d6304ccd466e4ec70bfa2
BLAKE2b-256 af56fd67ed81bcbdcda4971a818beba2a522ec6460da782b7e810303dc6060ce

See more details on using hashes here.

Provenance

The following attestation bundles were made for koboi_agent-0.5.0-py3-none-any.whl:

Publisher: release.yml on hedypamungkas/koboi-agent

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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