Universal configurable AI agent framework — production-grade, YAML-driven, open-source ready.
Project description
koboi-agent
Configurable AI agent framework for trustworthy unattended autonomy. YAML-driven config, async Python 3.10+, multi-provider LLM (OpenAI, Anthropic, Cloudflare).
Why koboi: durable, sandboxed, evaluable
koboi-agent's defensible position is the integration of five assets that are rare at the library level (no peer agent framework combines all five):
- Crash/redeploy resume — the SQLite
StepJournaleagerly writes arunningmarker before each LLM call (WAL), so a SIGKILL/redeploy leaves a resumable state;koboi run --resume <session>rehydrates and continues, re-executing only the missing tool calls. Reproducible proof + wall-clock:python benchmarks/crash_recovery/run.py. (LangGraph markets "durable execution" only at the platform/LangSmith tier.) - Seccomp HARD network isolation without a container — the restricted sandbox denies egress at the syscall layer (
connect/connectat/sendto/sendmsg, inherited acrossexecve) plus rlimits + PATH allowlist + secret-stripped env, on Linux + thepython3-seccompsystem package. No peer ships this without spinning up a container. - Self-hostable REST/SSE + autonomous-jobs server with a real security contract —
koboi serveexposes interactive SSE chat (human-in-the-loop approvals) + autonomous background jobs behind Bearer keys, per-session ownership, idempotency, and a graceful drain. The C3 contract: autonomous destructive jobs are refused unlesssandbox.backend='restricted', and approvals are deny-by-default without a Trust-DB rule. - CI-native agent evaluation you treat like code — the eve-style
tauthoring DSL (koboi eval-test) drives an agent and asserts outcomes (calledTool/toolWasBlocked/retrievedChunk/blocked/warned/activatedSkill/completed) with mock determinism (no API key burned on commit) and gate/soft severity, routed through 17 built-in scorers. - Supply-chain-hardened Skills — agentskills.io-aligned, 3-tier progressive disclosure, with a shell-injection deny-list on SKILL.md
!cmdpreprocessing (the "ClawHavoc" ~1,200-malicious-skills marketplace attack is a real, documented threat).
Try the HITL flow on a bare install — python examples/hitl_client.py (httpx-only; auto-resolves pending_approval events) against koboi serve configs/hitl_demo.yaml.
➡️ Full positioning & competitive analysis: docs/trustworthy-unattended-autonomy.md
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, ingest, handover
- Hook lifecycle: 15 event types for logging, guardrails, telemetry, plus declarative external-command hooks (
hooks:YAML — no Python required) - RAG pipeline: chunking (fixed/sentence/paragraph/semantic), retrieval (keyword/BM25/semantic/hybrid), cross-encoder rerank (jina/cohere/local), augmentation, query rewriting/HyDE, metadata filtering, Indonesian stopwords/stemmer, remote sources (HTTP/S3)
- Guardrails: input/output validation, rate limiting, approval workflows, policy engine
- Confidence-awareness + human handover: opt-in grounding guardrail (claim-decomposition + NLI judge — abstains when ungrounded), the
transfer_to_humantool, and structural handover detection — the bot yields to a human operator when it should (see docs/channel-bridge.md) - Multi-agent orchestration: keyword/LLM/hybrid routing; sequential, parallel, DAG, conditional, dynamic (LLM-planned), and deep_research (coverage-gated, cited web research) execution
- Deterministic workflow export: freeze a run into a re-runnable config bundle (
koboi export/import), and optionally capture the LLM response cache for byte-identical offline replay (koboi capture --with-cache,run --replay-mode replay— no API key) - Web research providers: pluggable search + fetch backends for the
web_search/web_fetchtools via@register_search_provider/@register_fetch_provider— built-in mock, DuckDuckGo, Brave, Firecrawl (search) + httpx/readability, Firecrawl (fetch) - 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, HMAC-signed job webhooks - Evaluation: BFCL, GAIA, SWE-bench, RAGAS, DeepEval + mock-safe IR scorers (recall@k/MRR/nDCG, citation grounding, bootstrap-CI gating); multilingual EN/ID production-readiness suite — see docs/rag-production-readiness-eval.md
- Terminal UI (Textual): chat, command palette, diff view, session management
Quickstart
Install
pip install koboi-agent # bare install: --help, validate, run, sessions, keys, mcp-serve, eval, eval-test, graph, diagnostics, init-zsh, export, import, capture, workflows
# Extras (optional):
# pip install koboi-agent[tui] # interactive `koboi chat` (Textual TUI)
# pip install koboi-agent[api] # `koboi serve` (HTTP/SSE server; `koboi keys` works on bare install)
# pip install koboi-agent[tokenizer] # accurate OpenAI token counts (tiktoken); chars/3 heuristic is the fallback
# pip install koboi-agent[rerank-local] # local BGE cross-encoder rerank (sentence-transformers); jina/cohere are API, no extra needed
# pip install koboi-agent[indo-nlp] # Indonesian stemmer (Sastrawi) for lexical RAG retrieval
# pip install koboi-agent[dev,tui,api] # everything (contributors)
Set your API key
cp .env.example .env
# Edit .env and set OPENAI_API_KEY
Run the CLI
Most commands work on a bare install (no extras needed):
koboi validate configs/simple_chat.yaml # check a config without running the agent
koboi run configs/simple_chat.yaml -m "What is 2 + 2?" # one-shot query (plain output)
koboi run configs/simple_chat.yaml --print # streaming JSON lines (pipe-friendly)
koboi keys create # mint an API key (for `koboi serve`)
koboi graph configs/dag_demo.yaml # render an orchestration DAG (Mermaid; --format json)
Interactive chat needs the [tui] extra:
pip install koboi-agent[tui]
koboi chat configs/simple_chat.yaml # Textual TUI; or `--print` for JSON lines (no extra)
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 config —
docker run -e KOBOI_CONFIG=/app/agent.yaml -v agent.yaml:/app/agent.yaml …(built-in path, zero code). - Mount an extensions dir —
docker run -e KOBOI_EXTENSIONS_DIR=/app/ext -v ext/:/app/ext …(custom tools / RAG retrievers viatools.custom/rag.custom_modules; the dir is auto-added tosys.path). - Derive a new image —
FROM ghcr.io/hedypamungkas/koboi-agent:<version>for fullcreate_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 | semantic
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
Deep research — iterative, cited web research (plan → search → fetch → assess coverage → drill
deeper → synthesize a cited report). Set execution.mode: deep_research + a web provider:
orchestration:
enabled: true
execution:
mode: deep_research
research:
max_depth: 3 # coverage-gated replan rounds
coverage_threshold: 0.7 # stop iterating once coverage >= this
citations: numbered
websearch:
search: { provider: firecrawl, firecrawl: { api_key: ${FIRECRAWL_API_KEY:} } }
fetch: { provider: firecrawl, firecrawl: { api_key: ${FIRECRAWL_API_KEY:} } }
Run: koboi run configs/deep_research_demo.yaml -m "Research solid-state battery breakthroughs in 2025-2026."
See docs/deep-research-smoke.md for the production quality bar + smoke scenarios.
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 37 numbered scripts covering every feature, plus server_built_in.py / server_customize.py (HTTP serving), hitl_client.py (HITL client), _command_hook_forwarder.py (external-command hook forwarder), and workflow-graph demos (workflow_graph_demo.py, dynamic_workflow_live.py, phase3_live_e2e.py):
| Range | Features |
|---|---|
| 01-04 | Basic chat and tool use |
| 05-08 | Context management, RAG, and guardrails |
| 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 |
| 33 | Declarative external-command hooks (hooks: YAML) |
| 34 | Modern RAG pipeline (BM25 + rewriting + filtering + reranking + caches) |
| 35 | Confidence-aware CS with human handover (configs/cs_confidence_handover.yaml; the confidence ladder) |
| 36 | Deterministic workflow export/import (koboi export/import; bundle = config + determinism profile) |
| 37 | Workflow cache + capture + offline replay (koboi capture --with-cache; run --replay-mode replay, no API key) |
| configs/deep_research_demo.yaml | Deep research (coverage-gated cited web research; koboi run + koboi serve) |
| server_* | koboi serve (built-in) and create_app() (customize) |
| hitl_client / workflow_graph_demo / dynamic_workflow_live / phase3_live_e2e | HITL client + DAG/workflow-graph demos |
Examples use click + rich (in the [tui] extra), so install that first:
pip install -e ".[tui]" # examples need click + rich
python examples/01_simple_chat.py # automatic mode
python examples/01_simple_chat.py -m interactive # interactive mode
# Server examples need [api]: pip install -e ".[api]"
# Bare-install-safe (no extras): 27, 29, 31, 32, hitl_client.py
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 - Confidence-awareness (
guardrails/grounding.py,hooks/handover_detection_hook.py) -- runtime grounding guardrail (abstain when ungrounded) + structural handover detection;transfer_to_humanyields to a human operator (see docs/channel-bridge.md) - PolicyEngine (
harness/) -- rule-based tool filtering - SkillRegistry (
skills/) -- skill discovery - ModeManager (
modes.py) -- chat/plan/act/auto/yolo 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 - ProactiveMemory (
proactive_memory.py) -- opt-in long-term memory: auto-extract durable facts (D), semantic recall + per-turn injection (C), always-in-context core block (B) - Redaction (
redact.py) -- shared secret masking (value-shape + key-name) for the journal/jobs/diagnostics - Server (
server/) -- FastAPI HTTP/SSE serving (interactive chat + autonomous jobs) - Orchestrator (
orchestration/) -- multi-agent coordination;deep_researchmode plans + runs cited web research (plan → DAG waves → coverage eval → synthesize) - Websearch providers (
websearch/) -- pluggable search/fetch backends (Brave/Firecrawl/ddg/mock + httpx/firecrawl) behind theweb_search/web_fetchtools - Workflow export (
workflows/) -- deterministic run capture:WorkflowDefinitionbundle +DeterminismProfile+ response-cache sidecar (koboi export/capture; offlinereplaymode); see docs/deterministic-workflow-export-strategy.md - 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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file koboi_agent-0.15.0.tar.gz.
File metadata
- Download URL: koboi_agent-0.15.0.tar.gz
- Upload date:
- Size: 878.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
61cf8baeac236dc49871c153bb2e723f54eccfaff3e90318a2059ece51728b4d
|
|
| MD5 |
855d22ccfbe00c19e8edd2bb56f3f168
|
|
| BLAKE2b-256 |
1c9dc7380e907ed0e8e54627931d6cf471f6ac357e354e313f177ab451f7f185
|
Provenance
The following attestation bundles were made for koboi_agent-0.15.0.tar.gz:
Publisher:
release.yml on hedypamungkas/koboi-agent
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
koboi_agent-0.15.0.tar.gz -
Subject digest:
61cf8baeac236dc49871c153bb2e723f54eccfaff3e90318a2059ece51728b4d - Sigstore transparency entry: 2171518080
- Sigstore integration time:
-
Permalink:
hedypamungkas/koboi-agent@fd29ca1f29cf08d048a791043c675cea1484573f -
Branch / Tag:
refs/tags/v0.15.0 - Owner: https://github.com/hedypamungkas
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@fd29ca1f29cf08d048a791043c675cea1484573f -
Trigger Event:
push
-
Statement type:
File details
Details for the file koboi_agent-0.15.0-py3-none-any.whl.
File metadata
- Download URL: koboi_agent-0.15.0-py3-none-any.whl
- Upload date:
- Size: 579.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
fb2341ec17db0604d2af075ad7dfafd97ff478383ed7e89e47abbee669b63e46
|
|
| MD5 |
d7a55027ac8b1f4cf4f3d4f687f30cdc
|
|
| BLAKE2b-256 |
d285ccc3db06f100262fb0a49c8d2b07f6b9dc08962adda2c5adb2327cce1ee2
|
Provenance
The following attestation bundles were made for koboi_agent-0.15.0-py3-none-any.whl:
Publisher:
release.yml on hedypamungkas/koboi-agent
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
koboi_agent-0.15.0-py3-none-any.whl -
Subject digest:
fb2341ec17db0604d2af075ad7dfafd97ff478383ed7e89e47abbee669b63e46 - Sigstore transparency entry: 2171518082
- Sigstore integration time:
-
Permalink:
hedypamungkas/koboi-agent@fd29ca1f29cf08d048a791043c675cea1484573f -
Branch / Tag:
refs/tags/v0.15.0 - Owner: https://github.com/hedypamungkas
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@fd29ca1f29cf08d048a791043c675cea1484573f -
Trigger Event:
push
-
Statement type: