@framers/agentos-guardrails
v0.1.2
Published
Bundled defense-in-depth guardrails for AgentOS — PII redaction, code safety, NLI grounding, ML content classifiers, embedding-based topicality. Tree-shake-friendly subpath exports per guardrail.
Readme
@framers/agentos-guardrails
⚠️ Pre-stable API. This package tracks the
@framers/agentoskernel lifecycle, currently at 0.x. Breaking changes may occur in any major bump until the kernel reaches 1.0.0. Pin to an exact version for reproducible builds:"@framers/agentos-guardrails": "0.1.0"(no^or~).
Bundled defense-in-depth guardrails for AgentOS — PII redaction, code safety, NLI grounding, ML content classifiers, embedding-based topicality. One install, five guardrails, tree-shake-friendly subpath exports.
Install
npm install @framers/agentos-guardrailsPeer dependency: @framers/agentos >= 0.7.0.
What's Inside
| Subpath | Guardrail | What it does |
|---|---|---|
| @framers/agentos-guardrails/pii | createPiiRedactionGuardrail | Four-tier PII detection: regex recognizers, NER pipeline, entity merging, redaction engine |
| @framers/agentos-guardrails/code-safety | createCodeSafetyGuardrail | Static-analysis on code emitted by agents (rm -rf, fork bombs, hardcoded secrets, eval) |
| @framers/agentos-guardrails/grounding | createGroundingGuardrail | NLI-based factual grounding verification per claim |
| @framers/agentos-guardrails/classifiers | createMLClassifierGuardrail | Toxicity, prompt-injection, NSFW classifiers via local ONNX |
| @framers/agentos-guardrails/topicality | createTopicalityGuardrail | Embedding-based on/off-topic detection |
Usage
Tight import — only the PII bundle's deps are pulled into your build:
import { AgentOS } from '@framers/agentos';
import { createPiiRedactionGuardrail } from '@framers/agentos-guardrails/pii';
const agentos = new AgentOS();
await agentos.initialize({
// ...
extensionManifest: {
packs: [
{ factory: () => createPiiRedactionGuardrail({ /* options */ }), enabled: true },
],
},
});Stack multiple guardrails:
import {
createPiiRedactionGuardrail,
createCodeSafetyGuardrail,
createTopicalityGuardrail,
} from '@framers/agentos-guardrails';
await agentos.initialize({
extensionManifest: {
packs: [
{ factory: () => createPiiRedactionGuardrail(), enabled: true },
{ factory: () => createCodeSafetyGuardrail(), enabled: true },
{ factory: () => createTopicalityGuardrail({ topics: ['support', 'billing'] }), enabled: true },
],
},
});Why Bundled
The five guardrails share an identical lifecycle (createXxxGuardrail() → ExtensionPack), the same single peer dep (@framers/agentos), and zero runtime dependencies between them. Shipping them as five separate npm packages was overhead, not separation of concerns. One bundled package with subpath exports gives consumers the exact same tree-shaking properties — bundlers strip the four guardrails you don't import — without forcing five npm install ceremonies.
Heavy model dependencies (NER models for PII, ONNX runtime for ML classifiers, NLI models for grounding) load only when you import the corresponding subpath. They are NOT pulled in transitively when you only import pii or code-safety.
See Also
License
Apache-2.0
