petfishFramework
A runtime control framework for enterprise AI agents — enforcing policy, budget, credentials, audit, replay, and Tool/MCP governance at execution time.
Status: v1.2.0 Stable — Core runtime APIs are frozen. Selected integrations remain experimental; see API Stability.
Quick Start (Zero Cost — No API Key)
pip install petfishframework
from petfishframework import Agent, ReAct
from petfishframework.tools.calculator import Calculator
from petfishframework.models.fake import FakeModel
# FakeModel — runs without any API key, perfect for testing
model = FakeModel.script_tool_then_answer(
tool_name="calculator",
tool_args={"expression": "17 * 23"},
final_answer="391",
)
agent = Agent(
model=model,
reasoning=ReAct(),
tools=(Calculator(),),
)
result = agent.run("What is 17 * 23?")
print(result.answer) # "391"
print(result.usage.total_tokens)
print(len(result.trajectory.steps), "steps")
Quick Start (Real LLM)
pip install "petfishframework[openai]"
from petfishframework import Agent, ReAct
from petfishframework.tools.calculator import Calculator
from petfishframework.models.openai import OpenAIModel
agent = Agent(
model=OpenAIModel(model="gpt-4o-mini"), # or model="openai:gpt-4o-mini"
reasoning=ReAct(),
tools=(Calculator(),),
)
result = agent.run("What is 17 * 23?")
print(result.answer) # "391"
Set OPENAI_API_KEY in .env or environment. Works with OpenAI-compatible APIs (SiliconFlow, etc.) via OPENAI_BASE_URL.
Budget Control (Runtime Hard Limits)
from petfishframework import Budget
# Budget is execution-scoped — pass to run() or session(), not Agent()
result = agent.run(
"Complex calculation task",
budget=Budget(max_tokens=1000, max_tool_calls=5, max_steps=10),
)
# Exceeding any limit raises BudgetExceeded
Permission Gate (Runtime Access Control)
from petfishframework.permissions.model import (
Decision, DecisionEffect, PermissionPolicy,
)
class DenyExpensiveTools:
"""Custom policy: deny tools tagged 'expensive'."""
def evaluate(self, subject, action, resource, context):
if "expensive" in resource.tags:
return Decision(effect=DecisionEffect.DENY, reason="too expensive")
return Decision(effect=DecisionEffect.ALLOW)
agent = Agent(
model=model,
reasoning=ReAct(),
tools=(Calculator(),),
permission_policy=DenyExpensiveTools(),
)
# Tool calls pass through the Environment chokepoint — denied calls never execute
Replay & Audit (Event-Sourced Sessions)
session = agent.session("What is 17 * 23?")
result = session.run()
# Every step is recorded — model calls, tool calls, permission decisions
for event in session.replay():
print(f"{event.type}: {event.data}")
# Events come from session.replay(), not from Result
# Result has: answer, usage, trajectory
# Session has: events, replay(), checkpoint()
MCP Client (External Tool Servers)
MCP stdio client is built into the core package — no extra install needed.
from petfishframework.mcp import connect_stdio
# Connect to a real MCP server
client = connect_stdio("npx", ["-y", "@modelcontextprotocol/server-filesystem", "/tmp"])
tools = client.discover_tools() # 14 tools: read_file, write_file, list_directory...
agent = Agent(model=model, reasoning=ReAct(), tools=tuple(tools))
result = agent.run("List all files in /tmp")
Reliability Evaluation (Pass^k)
from petfishframework.reliability import pass_at_k_with_perturbations, exact_match
from petfishframework.core.types import Task
# Run same task 8 times — measure consistency
result = pass_at_k_with_perturbations(
session_factory=lambda task: agent.session(task),
task=Task(prompt="What is 17 * 23?"),
k=8,
)
print(result.summary())
# Pass@8 — PASS (100%)
# canonical: 8/8
# order_shuffled: 8/8
# paraphrase: 8/8
Core Concepts
| Concept | Role |
|---|---|
| Agent | Immutable recipe (model + reasoning + tools) |
| Session | Event-sourced execution (auditable, replayable) |
| Environment | Single chokepoint (all calls audited, budget-metered, permission-gated) |
| Budget | Hard execution limits (tokens, cost, steps, tool calls) |
| Permission | SARC access control with 6 DecisionEffects |
| Replay | AUDIT event log via session.replay(); RERUN + RESUME via reliability.replay wrappers |
| Pass^k | Reliability metric (k repetitions + perturbation suite) |
Features
- 4 reasoning strategies: ReAct, LATS (MCTS search), LLM+P (symbolic planning), Reflexion (self-reflection)
- 3 model adapters: OpenAI, Anthropic, FakeModel (deterministic testing)
- 3 routing axes: ToolRegistry (auto tool selection), Adaptive-RAG (retrieval), ReasoningStrategy
- MCP client: real stdio transport, tool discovery from external MCP servers
- Multi-agent: AgentAsTool (supervisor delegates to specialist agents)
- Structured output: JSON → dataclass (zero regex scoring)
- Conversation memory: cross-session recall via ConversationStore
- Async + streaming: dual sync/async interface
Documentation
- Usage Guide — full lifecycle, 18 sections
- API Reference — definitive reference (2383 lines)
- Deployment Guide — Docker, Compose, Vault
- Compatibility Matrix — extras, models, migration notes
- Threat Model — security boundaries
- Adoption Guide — decision framework
- Architecture — design history (v0.2 historical)
- Benchmark Results — 3-tier strategy
- Examples — quickstart, tools+retrieval, multi-agent, enterprise, observability
Enterprise PoC
See examples/05_enterprise_expense.py and tests/test_enterprise_demo.py for a complete enterprise expense approval scenario demonstrating all 6 DecisionEffects.
Run (from a repository checkout): python examples/05_enterprise_expense.py
YAML Policy Engine
Configure permissions via YAML instead of Python:
from petfishframework.policies import YamlPolicy
policy = YamlPolicy.from_file("examples/policies/enterprise-expense.yaml")
policy.register_tools(tools)
agent = Agent(model=model, reasoning=ReAct(), tools=tools, permission_policy=policy)
Supported conditions: action.tool_name, subject.role_in, subject.role_not_in, action.args.amount_gt/lt, tool.side_effect, tool.external_egress.
CredentialBroker
Tools never hold raw API keys — they receive scoped, time-limited tokens:
from petfishframework.credentials import CredentialBroker
broker = CredentialBroker()
broker.register_credential("github_tool", os.environ["GITHUB_TOKEN"])
agent = Agent(model=model, reasoning=ReAct(), tools=tools, credential_broker=broker)
# Tools with requires_credentials=True receive a ScopedToken (repr-safe, auto-expiring)
Observability (OTel + SIEM)
from petfishframework.observability import OTelSink, SIEMSink
# OTel — creates spans for model/tool/session events (requires opentelemetry)
otel_sink = OTelSink() # no-op if opentelemetry not installed
# SIEM — structured JSON-Lines export for downstream SIEM ingestion
siem_sink = SIEMSink(output_path="audit.jsonl")
# Credentials auto-redacted; configure additional secret fields:
# siem_sink = SIEMSink(output_path="audit.jsonl", redact_keys=("api_key", "password"))
agent = Agent(model=model, reasoning=ReAct(), tools=tools)
# Attach sinks to the session's EventEmitter
session = agent.session("your task")
session.events.subscribe(otel_sink)
session.events.subscribe(siem_sink)
result = session.run()
Tool Governance
from petfishframework.tools import ToolGovernance, ToolSchemaValidator
from petfishframework.tools.rate_limiter import RateLimiter, RateLimitPolicy
governance = ToolGovernance(
schema_validator=ToolSchemaValidator(), # validate tool args before execution
rate_limiter=RateLimiter(), # per-tool sliding-window rate limit
)
agent = Agent(model=model, reasoning=ReAct(), tools=tools, tool_governance=governance)
Roadmap
- v0.2.x: Core runtime, permission semantics, enterprise PoC, Trusted Publishing ✅
- v0.3.x: YAML Policy Engine, CredentialBroker ✅
- v1.2.x (current): Enterprise hardening — ContextCompiler, EventStore, CapabilityCatalog, SecretProvider, MCP HTTP, SandboxBackend, RAG authorization, error codes, FastAPI server, SBOM, benchmarks
Current Limitations
petfishFramework v1.0 has a stable core runtime with selected experimental integrations.
| Capability | Status |
|---|---|
| Zero-cost quickstart | ✅ Available |
| ReAct / Budget / Pass^k | ✅ Available |
| DENY permission gate | ✅ Enforced (pre-execution block) |
| REQUIRE_APPROVAL | ✅ Enforced (pre-execution block) |
| PARTIAL_ALLOW | ✅ Enforced (pre-execution arg filtering) |
| MASK | ✅ Enforced (input mask before + output mask after) |
| DEGRADE | ✅ Enforced (fallback tool switching) |
| Session replay / deterministic rerun / resume | ✅ Available |
| OpenTelemetry + SIEM observability | ✅ Available |
| MCP client stdio | ✅ Available |
| MCP server mode | ✅ MVP (stdio JSON-RPC: initialize/tools.list/tools.call) |
| Structured output / conversation memory | ✅ Available |
| YAML Policy Engine | ✅ Available |
| Credential Broker | ✅ Available |
| Tool governance (schema/rate/timeout/retry/idempotency) | ✅ Available |
| Thread safety (EventEmitter/RateLimiter/IdempotencyStore) | ✅ Available |
| LATS full MCTS / LLM+P | 🔶 Experimental |
| CRAG / Adaptive-RAG | 🔶 Lightweight reference implementations |
| Sandbox subprocess isolation | 🔶 Phase 1 (not a security boundary) |
API Stability
| Area | Status |
|---|---|
| Agent / Session / RuntimeEnvironment | ✅ Stable |
| DecisionEffect semantics (all 6) | ✅ Stable |
| Budget / CostAccountant | ✅ Stable |
| CredentialBroker / ScopedToken | ✅ Stable |
| YAML Policy Engine | ✅ Stable |
| AuditReport / EventEmitter | ✅ Stable |
| SIEMSink (key-based redaction) | ✅ Stable |
| Tool schema validation / rate limiting | ✅ Stable |
| MCP client governance (allowlist/pin/risk) | ✅ Stable |
| Pass^k reliability metric | ✅ Stable |
| FrameworkConfig | ✅ Stable |
| MCP server mode | 🔶 Experimental (stdio JSON-RPC MVP) |
| OTel sink | 🔶 Experimental (optional dep) |
| Vault adapter | 🔶 Experimental (optional dep) |
| Deterministic replay / resume | 🔶 Experimental |
| LATS full MCTS / LLM+P | 🔶 Experimental |
| CRAG / Adaptive-RAG | 🔶 Lightweight reference |
| Sandbox executor | 🔶 Phase 1 (process isolation) |
See API Stability Policy for full classification and deprecation process.
Development
git clone https://github.com/kylecui/petfishFramework.git
cd petfishFramework
uv sync --all-extras
uv run pytest # 582 tests
uv run ruff check src/ tests/
See CONTRIBUTING.md for details.
License
MIT — © 2026 Kyle Cui
Metadata
Release files for petfishframework 1.3.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| petfishframework-1.3.0.tar.gz | 599.4 kB | With provenance | Details for petfishframework-1.3.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| petfishframework-1.3.0-py3-none-any.whl | Python 3 | none | any | Details for petfishframework-1.3.0-py3-none-any.whl |
Total release size: 755.8 kB
Release files / petfishframework-1.3.0.tar.gz
| Download URL | petfishframework-1.3.0.tar.gz |
|---|---|
| Size | 599.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
17896035fb60aff095109808ae77911016e98c1da85e10289f277172fa8e8f28
|
|
BLAKE2b-256 checksum How to use checksums |
2fee2180f79cf14fa69919510e1c8e4fa558c88363bd94a6dc07160c2f1df1e3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 3, 2026.
Transparency logRelease files / petfishframework-1.3.0-py3-none-any.whl
| Download URL | petfishframework-1.3.0-py3-none-any.whl |
|---|---|
| Size | 156.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
15bf40b86211d80dabbec341a34ab707c16ae9a02942ac67a2e88fc427b475fe
|
|
BLAKE2b-256 checksum How to use checksums |
5f19d47a46fcf996b33921e215007f7a93893c494191dcf45a6aaa5489ed7e09
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 3, 2026.
Transparency logSecurity for petfishframework 1.3.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
All 2 files in this release have been uploaded with provenance metadata.
Attestation for petfishframework-1.3.0.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 3, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.