Skip to content

docs: add reading order for the security model to GETTING_STARTED.md #156

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
AaliyaKhan25 wants to merge 2 commits into
base: dev
Choose a base branch
from
Open

docs: add reading order for the security model to GETTING_STARTED.md #156

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b5f6f30
docs: add reading order for the security model to GETTING_STARTED.md
AaliyaKhan25 Aug 23, 2026
3ef2138
docs: restore integrations/deployment table, keep security-model tabl…
AaliyaKhan25 Aug 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion sdk/docs/GETTING_STARTED.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,10 +97,22 @@ python -c "from unplug import Guard; print(Guard().scan('hello', source='user').
|------|-----|
| Wire Unplug into **your** agent loop | [`integrations/custom-loop/README.md`](https://github.com/UnplugAI/Unplug/blob/dev/sdk/integrations/custom-loop/README.md) |
| LangGraph, CrewAI, OpenAI Agents, … | [`integrations/README.md`](https://github.com/UnplugAI/Unplug/blob/dev/sdk/integrations/README.md) |
| **REVIEW** vs **BLOCK** (human approval) | [`docs/AGENT_ACTIONS.md`](AGENT_ACTIONS.md) |
| Full SDK reference | [`README.md`](https://github.com/UnplugAI/Unplug/blob/dev/sdk/README.md) |
| Hosted API / sidecar | [`docs/DEPLOYMENT.md`](DEPLOYMENT.md) |

## Understanding the security model

If you want to know why Unplug makes the decisions it does, read these in order:

| Goal | Doc |
|------|-----|
| The mental model: Guard → Pipelines → Scanners → Core, and how TaintedText/TrustLevel mark untrusted spans. Start here. | [`ARCHITECTURE.md`](ARCHITECTURE.md) |
| What happens to a marked span next: redact, block, or review. | [`AGENT_ACTIONS.md`](AGENT_ACTIONS.md) |
| Taint and actions across a full agent loop — session taint, `notify_taint_source`, adaptive degradation. | [`AGENT_FLOW_SECURITY.md`](AGENT_FLOW_SECURITY.md) |
| A worked example of the above: scanning context files, skills, and cron prompts before they reach the model. | [`HERMES_AGENT_SECURITY.md`](HERMES_AGENT_SECURITY.md) |
| The same taint/redact ideas applied to retrieval (RAG). | [`RAG_DEFENSE.md`](RAG_DEFENSE.md) |
| Once the model above makes sense, which imports to build against. | [`PUBLIC_API.md`](PUBLIC_API.md) |

## Common mistakes

| Mistake | Fix |
Expand Down