openscript-sdk 0.1.0__tar.gz

openscript_sdk-0.1.0/LICENSE

@@ -0,0 +1,190 @@
+
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but not
+   limited to compiled object code, generated documentation, and
+   conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work.
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including the original
+   version of the Work and any modifications or additions to that Work or
+   Derivative Works thereof, that is intentionally submitted to the Licensor
+   for inclusion in the Work by the copyright owner or by an individual or
+   Legal Entity authorized to submit on behalf of the copyright owner. For
+   the purposes of this definition, "submitted" means any form of electronic,
+   verbal, or written communication sent to the Licensor or its
+   representatives, including but not limited to communication on electronic
+   mailing lists, source code control systems, and issue tracking systems that
+   are managed by, or on behalf of, the Licensor for the purpose of discussing
+   and improving the Work, but excluding communication that is conspicuously
+   marked or otherwise designated in writing by the copyright owner as
+   "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by the Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding any notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+Copyright 2026 Sharif Parish / Bluesky Labs
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

openscript_sdk-0.1.0/PKG-INFO

@@ -0,0 +1,225 @@
+Metadata-Version: 2.4
+Name: openscript-sdk
+Version: 0.1.0
+Summary: Hold an AI agent's irreversible tool calls until a person approves that exact call
+Author: Sharif Parish
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/saintparish4/openscript
+Project-URL: Documentation, https://github.com/saintparish4/openscript/blob/master/docs/guide.md
+Project-URL: Source, https://github.com/saintparish4/openscript
+Project-URL: Issues, https://github.com/saintparish4/openscript/issues
+Project-URL: Demo, https://openscript-demo.vercel.app/
+Keywords: ai-agents,agent-security,prompt-injection,human-in-the-loop,tool-calling,llm,guardrails,claude-code
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Security
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pydantic<3,>=2.10
+Requires-Dist: structlog>=25.5.0
+Requires-Dist: pyyaml>=6.0
+Provides-Extra: ml
+Requires-Dist: sentence-transformers>=2.2; extra == "ml"
+Provides-Extra: redis
+Requires-Dist: redis>=7.3.0; extra == "redis"
+Provides-Extra: metrics
+Requires-Dist: prometheus-client>=0.24.1; extra == "metrics"
+Provides-Extra: otel
+Requires-Dist: opentelemetry-sdk>=1.27; extra == "otel"
+Requires-Dist: opentelemetry-exporter-otlp>=1.27; extra == "otel"
+Provides-Extra: server
+Requires-Dist: openscript-sdk[metrics,redis]; extra == "server"
+Requires-Dist: fastapi>=0.128.0; extra == "server"
+Requires-Dist: uvicorn>=0.42.0; extra == "server"
+Requires-Dist: sqlalchemy[asyncio]>=2.0.48; extra == "server"
+Requires-Dist: asyncpg>=0.31.0; extra == "server"
+Requires-Dist: python-dotenv>=1.0.0; extra == "server"
+Provides-Extra: demo
+Requires-Dist: openscript-sdk[metrics]; extra == "demo"
+Requires-Dist: rich>=13.0.0; extra == "demo"
+Requires-Dist: python-dotenv>=1.0.0; extra == "demo"
+Provides-Extra: dev
+Requires-Dist: pytest>=9.0.2; extra == "dev"
+Requires-Dist: pytest-asyncio>=1.3.0; extra == "dev"
+Requires-Dist: pytest-benchmark>=5.2.3; extra == "dev"
+Requires-Dist: black>=26.1.0; extra == "dev"
+Requires-Dist: ruff>=0.15.6; extra == "dev"
+Requires-Dist: mypy>=1.19.1; extra == "dev"
+Requires-Dist: types-PyYAML>=6.0; extra == "dev"
+Requires-Dist: hypothesis>=6.151.9; extra == "dev"
+Requires-Dist: build>=1.2; extra == "dev"
+Dynamic: license-file
+
+# OpenScript
+
+[![CI](https://github.com/saintparish4/openscript/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/saintparish4/openscript/actions/workflows/ci.yml)
+[![License: Apache 2.0](https://img.shields.io/badge/license-Apache%202.0-blue)](https://github.com/saintparish4/openscript/blob/master/LICENSE)
+[![Live demo](https://img.shields.io/badge/demo-live%20in%20your%20browser-22c55e)](https://openscript-demo.vercel.app/)
+
+**Irreversible actions wait for a person, even when the model has been fooled.**
+
+OpenScript sits between an AI agent and the tools it calls. It refuses calls
+outside rules you write, holds the ones that cannot be undone until a person
+approves that exact call, masks secrets and PII, and records every decision.
+None of it depends on recognising an attack, so it still holds when the model
+is fooled, wrong, or swapped for another.
+
+It is for anyone building an agent whose tools have real effects, such as
+payments, email or a shell, in Python with any framework. It is version
+0.1.0 and alpha: the API may still change.
+
+**[Try the live demo →](https://openscript-demo.vercel.app/)** The package
+runs in your browser tab, compiled to WebAssembly, with no backend.
+
+## What it is not
+
+- **Not an injection detector to rely on.** It has pattern detectors, and they
+  catch 2 to 7% of attacks they were not written for. The boundary is the
+  rules and the approvals, and the rules are only as tight as you write them.
+- **Not a compliance certification.** Its compliance presets assist a
+  program and certify nothing.
+
+## What it has been shown to do
+
+Measured on [AgentDojo](https://github.com/ethz-spylab/agentdojo)'s banking
+and Slack suites, with Qwen2.5-7B-Instruct, a model that follows prompt
+injections. The protocol was frozen before the run.
+
+| The run | |
+|---|---|
+| Hardware | 1 NVIDIA RTX 4090 on RunPod, Secure Cloud, EU-RO-1 |
+| Serving | vLLM 0.10.2, bf16, temperature 0 |
+| Size | 1,430 cases, 5,382 requests, 9.8M input and 0.63M output tokens |
+| Errors | 0 |
+| Date | 2026-11-04 |
+
+| Configuration | Attacks that succeeded | Attacker's irreversible actions that took effect |
+|---|---|---|
+| No protection | 58 of 249 | 108 |
+| Session rule: hold irreversible calls after an untrusted read | 6 of 249 | 10 |
+| Ask a person on every irreversible call | **0 of 249** | **0** |
+| No policy at all, effect side enforcing | **0 of 249** | **0** |
+
+- **The effect side is the boundary.** A ledger in front of each irreversible
+  tool applies a call only with a token minted when a person approves it. A
+  call that goes round the wrapper changes nothing.
+- **Safety has a price, and it is published.** In the run above, asking on
+  every irreversible call meant a person on 23 of the 37 ordinary tasks. In
+  the no-model replay of all four suites it is 59 of 97. The session rule
+  asks less and misses the attacks that arrive through Slack's channel
+  listing.
+- **It was attacked before it was trusted.** A [red team](https://github.com/saintparish4/openscript/blob/master/docs/red-team.md)
+  searched for bypasses and published 7 findings, each committed as a
+  failing test before its fix.
+
+Every number, with its date, command and caveats, is in
+[`docs/metrics.md`](https://github.com/saintparish4/openscript/blob/master/docs/metrics.md). The claim and what it does not cover
+are in [the threat model](https://github.com/saintparish4/openscript/blob/master/docs/threat-model.md).
+
+## How it works
+
+```
+agent ── calls a tool ──► SecureTool ── before: tool rules · session rule ──► refuse / hold for a person
+                              │
+                              ▼  the call that was checked, and nothing else
+                         effect side ── a person's token? ──► apply, and write it in the ledger
+                              │
+                              ▼
+                          after: mask secrets and PII · record
+```
+
+- **Tool rules** limit which tools, arguments, recipients and amounts are
+  allowed, in YAML.
+- **The session rule** remembers when a session has read something a
+  stranger wrote, and then holds the calls you list as irreversible.
+- **An approval** is single-use, expires in an hour, and is bound to the
+  tool, its exact arguments and the session.
+- **The effect side** ([`evals/ledger.py`](https://github.com/saintparish4/openscript/blob/master/evals/ledger.py)) is a reference
+  implementation, standard library only.
+
+## Quick start
+
+```bash
+pip install openscript-sdk          # Python 3.11+; pulls pydantic, structlog and PyYAML
+```
+
+The distribution is `openscript-sdk` and the package imports as
+`openscript_sdk`. The extras are `[server]` (the FastAPI server, whose
+database migrations are in this repository's `alembic/`), `[redis]`,
+`[metrics]` and `[otel]`. To work on it, clone the repository and run
+`make install`.
+
+A tool that the rules hold
+waits for a person, and the retry with the approval runs that exact call
+once:
+
+```python
+from openscript_sdk import ActionBlockedError, SecureTool, ToolFirewallPolicy
+
+async def transfer_funds(to: str, amount: int) -> str: ...
+
+transfer = SecureTool(transfer_funds, policies=[ToolFirewallPolicy(rules_path="tools.yaml")])
+
+call = {"to": "acct-22", "amount": 500}
+try:
+    await transfer.call(call)                       # held: the tool does not run
+except ActionBlockedError as held:
+    approval_id = held.approval_id                  # a person approves it ...
+
+await transfer.call(call, approval_id=approval_id)  # ... and the same call runs, once
+```
+
+```yaml
+# tools.yaml
+default_deny: true
+rules:
+  transfer_funds:
+    requires_approval: true
+    args:
+      amount: {min: 0, max: 1000}
+```
+
+Also in the package: redaction of secrets and PII, input screening, an audit
+trail and an event server. The [guide](https://github.com/saintparish4/openscript/blob/master/docs/guide.md) covers each.
+
+## Where it runs
+
+| Surface | Start here |
+|---|---|
+| Python agents and tools (LangChain, LangGraph, anything with `invoke`) | [the guide](https://github.com/saintparish4/openscript/blob/master/docs/guide.md) |
+| Claude Code, as a hook, with a strict profile that holds Bash after a web read | [the hook](https://github.com/saintparish4/openscript/blob/master/docs/guide.md#the-claude-code-hook-what-it-adds-and-what-it-does-not-do) |
+| Java agents, through the server | [`clients/java`](https://github.com/saintparish4/openscript/blob/master/clients/java/README.md) |
+| A browser, and a Chrome extension | [the demo](https://openscript-demo.vercel.app/) |
+
+## Further reading
+
+- [`docs/guide.md`](https://github.com/saintparish4/openscript/blob/master/docs/guide.md): every feature, its limits and its
+  configuration, including environment variables and options.
+- [`docs/metrics.md`](https://github.com/saintparish4/openscript/blob/master/docs/metrics.md): every measurement.
+- [`docs/threat-model.md`](https://github.com/saintparish4/openscript/blob/master/docs/threat-model.md) and
+  [`docs/red-team.md`](https://github.com/saintparish4/openscript/blob/master/docs/red-team.md): the claim and the attempts to
+  break it.
+- [`docs/submission.md`](https://github.com/saintparish4/openscript/blob/master/docs/submission.md): the AI-safety challenge
+  write-up.
+
+## Contributing
+
+```bash
+make install && pytest && ruff check . && black --check . && mypy --strict openscript_sdk/ --exclude openscript_sdk/server/
+```
+
+[CONTRIBUTING.md](https://github.com/saintparish4/openscript/blob/master/CONTRIBUTING.md) has the full checklist, including the
+Pyodide and Java checks. Changes to approvals, the session rule or the hook
+also run `pytest tests/bypass`.
+
+## License
+
+Apache License 2.0. See [LICENSE](https://github.com/saintparish4/openscript/blob/master/LICENSE).

openscript_sdk-0.1.0/README.md

@@ -0,0 +1,165 @@
+# OpenScript
+
+[![CI](https://github.com/saintparish4/openscript/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/saintparish4/openscript/actions/workflows/ci.yml)
+[![License: Apache 2.0](https://img.shields.io/badge/license-Apache%202.0-blue)](https://github.com/saintparish4/openscript/blob/master/LICENSE)
+[![Live demo](https://img.shields.io/badge/demo-live%20in%20your%20browser-22c55e)](https://openscript-demo.vercel.app/)
+
+**Irreversible actions wait for a person, even when the model has been fooled.**
+
+OpenScript sits between an AI agent and the tools it calls. It refuses calls
+outside rules you write, holds the ones that cannot be undone until a person
+approves that exact call, masks secrets and PII, and records every decision.
+None of it depends on recognising an attack, so it still holds when the model
+is fooled, wrong, or swapped for another.
+
+It is for anyone building an agent whose tools have real effects, such as
+payments, email or a shell, in Python with any framework. It is version
+0.1.0 and alpha: the API may still change.
+
+**[Try the live demo →](https://openscript-demo.vercel.app/)** The package
+runs in your browser tab, compiled to WebAssembly, with no backend.
+
+## What it is not
+
+- **Not an injection detector to rely on.** It has pattern detectors, and they
+  catch 2 to 7% of attacks they were not written for. The boundary is the
+  rules and the approvals, and the rules are only as tight as you write them.
+- **Not a compliance certification.** Its compliance presets assist a
+  program and certify nothing.
+
+## What it has been shown to do
+
+Measured on [AgentDojo](https://github.com/ethz-spylab/agentdojo)'s banking
+and Slack suites, with Qwen2.5-7B-Instruct, a model that follows prompt
+injections. The protocol was frozen before the run.
+
+| The run | |
+|---|---|
+| Hardware | 1 NVIDIA RTX 4090 on RunPod, Secure Cloud, EU-RO-1 |
+| Serving | vLLM 0.10.2, bf16, temperature 0 |
+| Size | 1,430 cases, 5,382 requests, 9.8M input and 0.63M output tokens |
+| Errors | 0 |
+| Date | 2026-11-04 |
+
+| Configuration | Attacks that succeeded | Attacker's irreversible actions that took effect |
+|---|---|---|
+| No protection | 58 of 249 | 108 |
+| Session rule: hold irreversible calls after an untrusted read | 6 of 249 | 10 |
+| Ask a person on every irreversible call | **0 of 249** | **0** |
+| No policy at all, effect side enforcing | **0 of 249** | **0** |
+
+- **The effect side is the boundary.** A ledger in front of each irreversible
+  tool applies a call only with a token minted when a person approves it. A
+  call that goes round the wrapper changes nothing.
+- **Safety has a price, and it is published.** In the run above, asking on
+  every irreversible call meant a person on 23 of the 37 ordinary tasks. In
+  the no-model replay of all four suites it is 59 of 97. The session rule
+  asks less and misses the attacks that arrive through Slack's channel
+  listing.
+- **It was attacked before it was trusted.** A [red team](https://github.com/saintparish4/openscript/blob/master/docs/red-team.md)
+  searched for bypasses and published 7 findings, each committed as a
+  failing test before its fix.
+
+Every number, with its date, command and caveats, is in
+[`docs/metrics.md`](https://github.com/saintparish4/openscript/blob/master/docs/metrics.md). The claim and what it does not cover
+are in [the threat model](https://github.com/saintparish4/openscript/blob/master/docs/threat-model.md).
+
+## How it works
+
+```
+agent ── calls a tool ──► SecureTool ── before: tool rules · session rule ──► refuse / hold for a person
+                              │
+                              ▼  the call that was checked, and nothing else
+                         effect side ── a person's token? ──► apply, and write it in the ledger
+                              │
+                              ▼
+                          after: mask secrets and PII · record
+```
+
+- **Tool rules** limit which tools, arguments, recipients and amounts are
+  allowed, in YAML.
+- **The session rule** remembers when a session has read something a
+  stranger wrote, and then holds the calls you list as irreversible.
+- **An approval** is single-use, expires in an hour, and is bound to the
+  tool, its exact arguments and the session.
+- **The effect side** ([`evals/ledger.py`](https://github.com/saintparish4/openscript/blob/master/evals/ledger.py)) is a reference
+  implementation, standard library only.
+
+## Quick start
+
+```bash
+pip install openscript-sdk          # Python 3.11+; pulls pydantic, structlog and PyYAML
+```
+
+The distribution is `openscript-sdk` and the package imports as
+`openscript_sdk`. The extras are `[server]` (the FastAPI server, whose
+database migrations are in this repository's `alembic/`), `[redis]`,
+`[metrics]` and `[otel]`. To work on it, clone the repository and run
+`make install`.
+
+A tool that the rules hold
+waits for a person, and the retry with the approval runs that exact call
+once:
+
+```python
+from openscript_sdk import ActionBlockedError, SecureTool, ToolFirewallPolicy
+
+async def transfer_funds(to: str, amount: int) -> str: ...
+
+transfer = SecureTool(transfer_funds, policies=[ToolFirewallPolicy(rules_path="tools.yaml")])
+
+call = {"to": "acct-22", "amount": 500}
+try:
+    await transfer.call(call)                       # held: the tool does not run
+except ActionBlockedError as held:
+    approval_id = held.approval_id                  # a person approves it ...
+
+await transfer.call(call, approval_id=approval_id)  # ... and the same call runs, once
+```
+
+```yaml
+# tools.yaml
+default_deny: true
+rules:
+  transfer_funds:
+    requires_approval: true
+    args:
+      amount: {min: 0, max: 1000}
+```
+
+Also in the package: redaction of secrets and PII, input screening, an audit
+trail and an event server. The [guide](https://github.com/saintparish4/openscript/blob/master/docs/guide.md) covers each.
+
+## Where it runs
+
+| Surface | Start here |
+|---|---|
+| Python agents and tools (LangChain, LangGraph, anything with `invoke`) | [the guide](https://github.com/saintparish4/openscript/blob/master/docs/guide.md) |
+| Claude Code, as a hook, with a strict profile that holds Bash after a web read | [the hook](https://github.com/saintparish4/openscript/blob/master/docs/guide.md#the-claude-code-hook-what-it-adds-and-what-it-does-not-do) |
+| Java agents, through the server | [`clients/java`](https://github.com/saintparish4/openscript/blob/master/clients/java/README.md) |
+| A browser, and a Chrome extension | [the demo](https://openscript-demo.vercel.app/) |
+
+## Further reading
+
+- [`docs/guide.md`](https://github.com/saintparish4/openscript/blob/master/docs/guide.md): every feature, its limits and its
+  configuration, including environment variables and options.
+- [`docs/metrics.md`](https://github.com/saintparish4/openscript/blob/master/docs/metrics.md): every measurement.
+- [`docs/threat-model.md`](https://github.com/saintparish4/openscript/blob/master/docs/threat-model.md) and
+  [`docs/red-team.md`](https://github.com/saintparish4/openscript/blob/master/docs/red-team.md): the claim and the attempts to
+  break it.
+- [`docs/submission.md`](https://github.com/saintparish4/openscript/blob/master/docs/submission.md): the AI-safety challenge
+  write-up.
+
+## Contributing
+
+```bash
+make install && pytest && ruff check . && black --check . && mypy --strict openscript_sdk/ --exclude openscript_sdk/server/
+```
+
+[CONTRIBUTING.md](https://github.com/saintparish4/openscript/blob/master/CONTRIBUTING.md) has the full checklist, including the
+Pyodide and Java checks. Changes to approvals, the session rule or the hook
+also run `pytest tests/bypass`.
+
+## License
+
+Apache License 2.0. See [LICENSE](https://github.com/saintparish4/openscript/blob/master/LICENSE).