ag2-acgs 0.1.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- ag2_acgs-0.1.0/.gitignore +12 -0
- ag2_acgs-0.1.0/CHANGELOG.md +20 -0
- ag2_acgs-0.1.0/LICENSE +175 -0
- ag2_acgs-0.1.0/PKG-INFO +362 -0
- ag2_acgs-0.1.0/README.md +333 -0
- ag2_acgs-0.1.0/examples/quickstart.py +72 -0
- ag2_acgs-0.1.0/pyproject.toml +148 -0
- ag2_acgs-0.1.0/src/ag2_acgs/__init__.py +27 -0
- ag2_acgs-0.1.0/src/ag2_acgs/_governance.py +310 -0
- ag2_acgs-0.1.0/src/ag2_acgs/middleware.py +397 -0
- ag2_acgs-0.1.0/src/ag2_acgs/py.typed +0 -0
- ag2_acgs-0.1.0/tests/__init__.py +0 -0
- ag2_acgs-0.1.0/tests/conftest.py +6 -0
- ag2_acgs-0.1.0/tests/fakes.py +80 -0
- ag2_acgs-0.1.0/tests/mcp_server.py +35 -0
- ag2_acgs-0.1.0/tests/test_default_constitution.py +90 -0
- ag2_acgs-0.1.0/tests/test_examples.py +88 -0
- ag2_acgs-0.1.0/tests/test_governance.py +286 -0
- ag2_acgs-0.1.0/tests/test_imports.py +23 -0
- ag2_acgs-0.1.0/tests/test_mcp.py +27 -0
- ag2_acgs-0.1.0/tests/test_middleware.py +158 -0
- ag2_acgs-0.1.0/tests/test_review.py +157 -0
- ag2_acgs-0.1.0/tests/test_tool_coverage.py +170 -0
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
All notable changes to this project are documented in this file.
|
|
4
|
+
The format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/) and the project uses
|
|
5
|
+
[Semantic Versioning](https://semver.org/). Entries for new releases are generated with `cz bump`.
|
|
6
|
+
|
|
7
|
+
## [Unreleased]
|
|
8
|
+
|
|
9
|
+
## 0.1.0 (2026-10-23)
|
|
10
|
+
|
|
11
|
+
### Added
|
|
12
|
+
|
|
13
|
+
- `ACGSGuard` with `guard.middleware`: an AG2 middleware that checks each tool call's name and arguments against
|
|
14
|
+
an ACGS constitution in `on_tool_execution`, before the tool runs, and returns the denial reason as the tool
|
|
15
|
+
result.
|
|
16
|
+
- Review through AG2's human-input hook with `ToolApprovalRequest`; a missing hook, a failing hook or a timeout
|
|
17
|
+
denies the call.
|
|
18
|
+
- Refusal of tools the middleware cannot check (provider-hosted tools, `tasks=`, sub-agents without the guard)
|
|
19
|
+
before the model is called, and detection of hosted tool calls reported by the provider.
|
|
20
|
+
- `on_review="deny"`, `review_timeout=`, `allow_ungoverned=True` and `tool_call_formatter=` options.
|
ag2_acgs-0.1.0/LICENSE
ADDED
|
@@ -0,0 +1,175 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
ag2_acgs-0.1.0/PKG-INFO
ADDED
|
@@ -0,0 +1,362 @@
|
|
|
1
|
+
Metadata-Version: 2.5
|
|
2
|
+
Name: ag2-acgs
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: ACGS rule-based tool-call governance for AG2 agents, via tool middleware and human approval
|
|
5
|
+
Project-URL: Homepage, https://github.com/acgs-ai/ag2-acgs
|
|
6
|
+
Project-URL: Documentation, https://github.com/acgs-ai/ag2-acgs#readme
|
|
7
|
+
Project-URL: Repository, https://github.com/acgs-ai/ag2-acgs
|
|
8
|
+
Project-URL: Issues, https://github.com/acgs-ai/ag2-acgs/issues
|
|
9
|
+
Project-URL: Changelog, https://github.com/acgs-ai/ag2-acgs/blob/main/CHANGELOG.md
|
|
10
|
+
Author: Martin Lyu
|
|
11
|
+
License-Expression: Apache-2.0
|
|
12
|
+
License-File: LICENSE
|
|
13
|
+
Keywords: acgs,ag2,agents,ai,autogen,governance,human-in-the-loop,middleware,tool-calls
|
|
14
|
+
Classifier: Development Status :: 3 - Alpha
|
|
15
|
+
Classifier: Intended Audience :: Developers
|
|
16
|
+
Classifier: Operating System :: OS Independent
|
|
17
|
+
Classifier: Programming Language :: Python :: 3
|
|
18
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
19
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
20
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
21
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
22
|
+
Classifier: Programming Language :: Python :: 3.14
|
|
23
|
+
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
|
|
24
|
+
Classifier: Typing :: Typed
|
|
25
|
+
Requires-Python: >=3.10
|
|
26
|
+
Requires-Dist: acgs-lite<4,>=3.0.1
|
|
27
|
+
Requires-Dist: ag2<2,>=1.2.0
|
|
28
|
+
Description-Content-Type: text/markdown
|
|
29
|
+
|
|
30
|
+
# ag2-acgs
|
|
31
|
+
|
|
32
|
+
[](https://github.com/acgs-ai/ag2-acgs/actions/workflows/ci.yml)
|
|
33
|
+
[](https://pypi.org/project/ag2-acgs/)
|
|
34
|
+
[](https://pypi.org/project/ag2-acgs/)
|
|
35
|
+
|
|
36
|
+
`ag2-acgs` checks [AG2](https://github.com/ag2ai/ag2) tool calls against [ACGS](https://pypi.org/project/acgs-lite/)
|
|
37
|
+
constitution rules before the tool runs. It is one AG2 middleware that uses documented AG2 hooks:
|
|
38
|
+
|
|
39
|
+
- `BaseMiddleware.on_tool_execution`, which wraps every tool call that runs in the agent's process;
|
|
40
|
+
- `context.ask(ToolApprovalRequest(...))`, the human-input request AG2's own `approval_required` uses, for calls
|
|
41
|
+
that need review.
|
|
42
|
+
|
|
43
|
+
What happens to a call:
|
|
44
|
+
|
|
45
|
+
- Calls that match no blocking rule run unchanged.
|
|
46
|
+
- Calls that match a blocking rule do not run. The model gets the reason as the tool result and can continue.
|
|
47
|
+
- Calls that only match review rules are put to a human through the agent's human-input hook. They run only if the
|
|
48
|
+
answer is `yes`, `y` or `1`. Any other answer, no hook, a hook error or a timeout denies the call.
|
|
49
|
+
- A blocking rule always wins. Nobody is asked to approve a blocked call.
|
|
50
|
+
- Any error while evaluating a call (including arguments that are not valid JSON) denies it (fail-closed).
|
|
51
|
+
- A turn on an agent with tools the middleware cannot check (provider-hosted tools, `tasks=TaskConfig(...)`
|
|
52
|
+
sub-tasks, sub-agents without ACGS) fails with `UngovernedToolsError` before the model is called.
|
|
53
|
+
|
|
54
|
+
The package is a thin adapter over the public `acgs-lite` API.
|
|
55
|
+
|
|
56
|
+
> [!NOTE]
|
|
57
|
+
> This is a community package. It is not part of AG2 and is not maintained, reviewed or endorsed by the AG2
|
|
58
|
+
> maintainers.
|
|
59
|
+
|
|
60
|
+
## Installation
|
|
61
|
+
|
|
62
|
+
```bash
|
|
63
|
+
pip install ag2-acgs
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
Requires Python 3.10 or later, `ag2>=1.2.0,<2` and `acgs-lite>=3.0.1,<4`. Install `ag2[mcp]` to use `MCPToolkit`.
|
|
67
|
+
|
|
68
|
+
## Usage
|
|
69
|
+
|
|
70
|
+
```python
|
|
71
|
+
from ag2 import Agent
|
|
72
|
+
|
|
73
|
+
from ag2_acgs import ACGSGuard
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
def send_email(to: str, body: str) -> str:
|
|
77
|
+
"""Send an email."""
|
|
78
|
+
return f"sent to {to}"
|
|
79
|
+
|
|
80
|
+
|
|
81
|
+
guard = ACGSGuard()
|
|
82
|
+
# config is any AG2 model config, for example OpenAIConfig(model=...) from ag2.config (pip install "ag2[openai]").
|
|
83
|
+
agent = Agent("assistant", config=config, tools=[send_email], middleware=[guard.middleware])
|
|
84
|
+
|
|
85
|
+
# For one ask only:
|
|
86
|
+
# await agent.ask("...", middleware=[guard.middleware])
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
## Quickstart
|
|
90
|
+
|
|
91
|
+
`examples/quickstart.py` runs offline. AG2's scripted test model (`ag2.testing.TestConfig`) stands in for a real
|
|
92
|
+
model:
|
|
93
|
+
|
|
94
|
+
```python
|
|
95
|
+
"""Block, allow and review tool calls with ag2-acgs. Runs offline: python examples/quickstart.py"""
|
|
96
|
+
|
|
97
|
+
import asyncio
|
|
98
|
+
import json
|
|
99
|
+
|
|
100
|
+
from acgs_lite import Constitution, Rule, Severity, ViolationAction
|
|
101
|
+
from ag2 import Agent
|
|
102
|
+
from ag2.events import HumanInputRequest, TextInput, ToolCallEvent, ToolResultEvent
|
|
103
|
+
from ag2.testing import TestConfig
|
|
104
|
+
|
|
105
|
+
from ag2_acgs import ACGSGuard
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
def send_email(to: str, body: str) -> str:
|
|
109
|
+
"""Send an email."""
|
|
110
|
+
return f"sent to {to}"
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
def get_weather(city: str) -> str:
|
|
114
|
+
"""Get the weather for a city."""
|
|
115
|
+
return f"Sunny in {city}"
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
def issue_refund(order_id: str, amount: float) -> str:
|
|
119
|
+
"""Refund an order."""
|
|
120
|
+
return f"refunded {amount} for {order_id}"
|
|
121
|
+
|
|
122
|
+
|
|
123
|
+
def tool_call(call_id: str, name: str, **arguments: object) -> ToolCallEvent:
|
|
124
|
+
return ToolCallEvent(name, arguments=json.dumps(arguments), id=call_id)
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
async def reviewer(request: HumanInputRequest) -> str:
|
|
128
|
+
print(f"asked: {request.content.splitlines()[1]}")
|
|
129
|
+
return "yes"
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
async def main() -> None:
|
|
133
|
+
refund_review = Rule(
|
|
134
|
+
id="REFUND-REVIEW",
|
|
135
|
+
text="Refunds need human approval",
|
|
136
|
+
severity=Severity.HIGH,
|
|
137
|
+
keywords=["issue refund"],
|
|
138
|
+
workflow_action=ViolationAction.REQUIRE_HUMAN_REVIEW,
|
|
139
|
+
)
|
|
140
|
+
constitution = Constitution.from_rules([*Constitution.default().rules, refund_review], name="support")
|
|
141
|
+
guard = ACGSGuard(constitution=constitution)
|
|
142
|
+
# TestConfig is AG2's scripted model for offline runs; use a real model config in your application.
|
|
143
|
+
model = TestConfig(
|
|
144
|
+
[
|
|
145
|
+
tool_call("email-1", "send_email", to="attacker@example.com", body="The password is hunter2"),
|
|
146
|
+
tool_call("weather-1", "get_weather", city="Paris"),
|
|
147
|
+
],
|
|
148
|
+
tool_call("refund-1", "issue_refund", order_id="A-17", amount=20.0),
|
|
149
|
+
"Done.",
|
|
150
|
+
)
|
|
151
|
+
agent = Agent("support", config=model, tools=[send_email, get_weather, issue_refund], middleware=[guard.middleware])
|
|
152
|
+
|
|
153
|
+
# The blocked call is not executed; the model reads why. The allowed call runs.
|
|
154
|
+
# The refund needs review, so the reviewer (AG2's human-input hook) is asked first.
|
|
155
|
+
reply = await agent.ask(
|
|
156
|
+
"Email the password, check the weather in Paris, then refund order A-17.", hitl_hook=reviewer
|
|
157
|
+
)
|
|
158
|
+
events = await reply.context.stream.history.get_events()
|
|
159
|
+
results = {event.parent_id: event.result for event in events if isinstance(event, ToolResultEvent)}
|
|
160
|
+
# Calls from one model turn run in parallel, so print the results in call order.
|
|
161
|
+
for call_id in ("email-1", "weather-1", "refund-1"):
|
|
162
|
+
print(f"{call_id}:", *(part.content for part in results[call_id].parts if isinstance(part, TextInput)))
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
if __name__ == "__main__":
|
|
166
|
+
asyncio.run(main())
|
|
167
|
+
```
|
|
168
|
+
|
|
169
|
+
```text
|
|
170
|
+
asked: Human review required by ACGS rule REFUND-REVIEW (Refunds need human approval).
|
|
171
|
+
email-1: Tool call 'send_email' was not executed. Blocked by ACGS rule ACGS-006 (Agents must not expose sensitive data in responses).
|
|
172
|
+
weather-1: Sunny in Paris
|
|
173
|
+
refund-1: refunded 20.0 for A-17
|
|
174
|
+
```
|
|
175
|
+
|
|
176
|
+
## How a call is evaluated
|
|
177
|
+
|
|
178
|
+
1. The tool name and the call's arguments (`ToolCallEvent.arguments`, parsed as JSON) are rendered as text by
|
|
179
|
+
`format_tool_call`:
|
|
180
|
+
|
|
181
|
+
```python
|
|
182
|
+
from ag2_acgs import format_tool_call
|
|
183
|
+
|
|
184
|
+
print(format_tool_call("update_config", {"service": "billing", "change": "disable\nlogging", "dryRun": False}))
|
|
185
|
+
```
|
|
186
|
+
|
|
187
|
+
```text
|
|
188
|
+
tool: update_config
|
|
189
|
+
arguments:
|
|
190
|
+
change: disable logging
|
|
191
|
+
dryRun: false
|
|
192
|
+
service: billing
|
|
193
|
+
normalized: update config | dry run
|
|
194
|
+
```
|
|
195
|
+
|
|
196
|
+
Each argument leaf is one `path: value` line (nested values use `a.b[0].c` paths), so both argument names and
|
|
197
|
+
values are visible to rules. Whitespace inside values is collapsed so phrases split across lines still match.
|
|
198
|
+
Identifiers written in `snake_case`, `kebab-case` or `camelCase` (the tool name, argument names, and
|
|
199
|
+
single-token string values) are repeated as plain words on the `normalized:` line, so the keyword
|
|
200
|
+
`skip audit` also matches a tool called `skip_audit`. Nothing is truncated.
|
|
201
|
+
Pass `tool_call_formatter=` to use a different representation.
|
|
202
|
+
|
|
203
|
+
The arguments are the ones the model sent, before AG2 fills in defaults.
|
|
204
|
+
|
|
205
|
+
2. The text is validated with `acgs_lite.GovernanceEngine.validate` against the constitution
|
|
206
|
+
(`Constitution.default()` unless you pass one).
|
|
207
|
+
|
|
208
|
+
3. The result decides what happens to the call:
|
|
209
|
+
|
|
210
|
+
| ACGS outcome | Result |
|
|
211
|
+
|---|---|
|
|
212
|
+
| No blocking rule matched (warn-only rules may match) | The tool runs |
|
|
213
|
+
| Only `require_human_review` / `escalate_to_senior` rules matched | Review (see below) |
|
|
214
|
+
| Any `block`, `block_and_notify` or `halt_and_alert` rule matched | Denied |
|
|
215
|
+
| A rule ID not found in the constitution, or an invalid result without a rule | Denied |
|
|
216
|
+
| Any exception while reading or evaluating the call | Denied (fail-closed) |
|
|
217
|
+
|
|
218
|
+
A matched blocking rule is never downgraded to review because a review rule matched as well.
|
|
219
|
+
The denial reason then lists only the blocking rules after "Blocked by" and names the matched review
|
|
220
|
+
rules separately.
|
|
221
|
+
|
|
222
|
+
A denied call is not executed. The middleware returns a `ToolResultEvent` with
|
|
223
|
+
`"Tool call '<name>' was not executed. <reason>"`, so the model gets the reason as the tool result. The reason
|
|
224
|
+
names the matched rules but never repeats argument values. The result's `ToolResult.metadata["acgs_decision"]`
|
|
225
|
+
(`DECISION_METADATA_KEY`) holds the verdict, reason, rule IDs and any evaluation error.
|
|
226
|
+
`ACGSGuard.evaluate(tool_name, args)` returns the `GovernanceDecision` without running anything.
|
|
227
|
+
|
|
228
|
+
The middleware never raises from `on_tool_execution`: AG2 drops the result of a call whose middleware raises, so
|
|
229
|
+
the model would see no answer at all.
|
|
230
|
+
|
|
231
|
+
## Review
|
|
232
|
+
|
|
233
|
+
A call that needs review is put to a human with `context.ask(ToolApprovalRequest(...))`. AG2 routes it to the
|
|
234
|
+
`hitl_hook` of the agent (`Agent(..., hitl_hook=...)`) or of the ask (`agent.ask(..., hitl_hook=...)`):
|
|
235
|
+
|
|
236
|
+
```python
|
|
237
|
+
from ag2.events import HumanInputRequest, ToolApprovalRequest
|
|
238
|
+
|
|
239
|
+
|
|
240
|
+
async def reviewer(request: HumanInputRequest) -> str:
|
|
241
|
+
if isinstance(request, ToolApprovalRequest):
|
|
242
|
+
print(request.tool_call_id, request.content)
|
|
243
|
+
return input("> ") # "yes", "y" or "1" runs the call; anything else denies it
|
|
244
|
+
```
|
|
245
|
+
|
|
246
|
+
Things to know:
|
|
247
|
+
|
|
248
|
+
- The prompt names the tool, its arguments and the matched review rules, and ends with `Approve this call?
|
|
249
|
+
(yes/no)`. The reviewer sees argument values; the model never does.
|
|
250
|
+
- Without a hook AG2 raises `HumanInputNotProvidedError`; with `review_timeout=` set, an unanswered request raises
|
|
251
|
+
`HumanInputTimeoutError`; a hook that raises becomes `HumanInputFailedError`. Each of these denies the call
|
|
252
|
+
with "No approval was received (...)", and the turn goes on. (AG2's own `approval_required` ends the turn in
|
|
253
|
+
these cases instead.)
|
|
254
|
+
- There is no "always" answer. Every call is checked and asked about on its own.
|
|
255
|
+
- Use `on_review="deny"` for agents nobody can answer for, such as background jobs.
|
|
256
|
+
|
|
257
|
+
## What is covered
|
|
258
|
+
|
|
259
|
+
| Tool | Checked | How |
|
|
260
|
+
|---|---|---|
|
|
261
|
+
| Function tools (plain functions, `@tool`, `FunctionTool`) and toolkits (`Toolkit`, `MCPToolkit`, filesystem, search and skills toolkits) | Yes | `on_tool_execution` |
|
|
262
|
+
| `ClientTool` (the caller runs it) | Yes | A denied call never reaches the caller |
|
|
263
|
+
| `AnthropicBashTool`, and the tools deferred by `ToolSearchTool` | Yes | `on_tool_execution` |
|
|
264
|
+
| Sub-agent tools (`agent.as_tool(...)`) | The call to the sub-agent, yes | The sub-agent needs its own `guard.middleware`, or it is refused |
|
|
265
|
+
| Provider-hosted tools in `ag2.tools.builtin` (web search, web fetch, code execution, file search, hosted MCP, image generation, shell, memory, retrieval, skills, X search, Google Maps) | No | The provider runs them; refused |
|
|
266
|
+
| `tasks=TaskConfig(...)` | No | Sub-task agents run this agent's tools without its middleware; refused |
|
|
267
|
+
|
|
268
|
+
Refused means `UngovernedToolsError` before the model is called. AG2 has no hook that shows middleware the
|
|
269
|
+
tools passed to one `agent.ask(..., tools=[...])`, so a hosted tool added that way is only detected when the
|
|
270
|
+
provider reports its call: the turn then ends with `UngovernedToolsError`, after the provider ran it. Pass
|
|
271
|
+
`allow_ungoverned=True` to run such tools with a logged warning instead; their calls are not checked.
|
|
272
|
+
`ACGSGuard.ungoverned_tools(agent)` lists what would be refused.
|
|
273
|
+
|
|
274
|
+
## Middleware order
|
|
275
|
+
|
|
276
|
+
AG2 runs agent middleware in list order, outermost first, and a tool's own middleware (`@tool(middleware=...)`)
|
|
277
|
+
inside all agent middleware. Middleware after the guard, and tool-level middleware, run after the check: a hook
|
|
278
|
+
there that changes the call changes it unchecked. Put `guard.middleware` last in `middleware=[...]`.
|
|
279
|
+
|
|
280
|
+
## Custom constitutions
|
|
281
|
+
|
|
282
|
+
```python
|
|
283
|
+
from acgs_lite import Constitution, Rule, Severity, ViolationAction
|
|
284
|
+
|
|
285
|
+
from ag2_acgs import ACGSGuard
|
|
286
|
+
|
|
287
|
+
constitution = Constitution.from_rules(
|
|
288
|
+
[
|
|
289
|
+
Rule(
|
|
290
|
+
id="NO-DESTRUCTIVE-SQL",
|
|
291
|
+
text="No destructive SQL",
|
|
292
|
+
severity=Severity.CRITICAL,
|
|
293
|
+
keywords=["drop table", "truncate table"],
|
|
294
|
+
),
|
|
295
|
+
Rule(
|
|
296
|
+
id="REFUND-REVIEW",
|
|
297
|
+
text="Refunds need approval",
|
|
298
|
+
severity=Severity.HIGH,
|
|
299
|
+
keywords=["refund"],
|
|
300
|
+
workflow_action=ViolationAction.REQUIRE_HUMAN_REVIEW,
|
|
301
|
+
),
|
|
302
|
+
],
|
|
303
|
+
name="payments",
|
|
304
|
+
)
|
|
305
|
+
guard = ACGSGuard(constitution=constitution, agent_id="payments-app")
|
|
306
|
+
```
|
|
307
|
+
|
|
308
|
+
`Constitution.from_yaml("rules.yaml")` works as well. To enforce two constitutions, add two guards; a call runs
|
|
309
|
+
only if both allow it.
|
|
310
|
+
|
|
311
|
+
## Options
|
|
312
|
+
|
|
313
|
+
| Argument | Default | Meaning |
|
|
314
|
+
|---|---|---|
|
|
315
|
+
| `constitution` | `Constitution.default()` | Rules to enforce |
|
|
316
|
+
| `agent_id` | `"ag2"` | Agent identifier recorded by ACGS |
|
|
317
|
+
| `on_review` | `"ask"` | `"ask"` (put the call to a human) or `"deny"` |
|
|
318
|
+
| `review_timeout` | `None` | Seconds to wait for the human; `None` waits as long as it takes |
|
|
319
|
+
| `allow_ungoverned` | `False` | Run tools the middleware cannot check, with a logged warning, instead of raising |
|
|
320
|
+
| `tool_call_formatter` | `format_tool_call` | `(tool_name, args) -> str` used as the evaluated text |
|
|
321
|
+
|
|
322
|
+
## Limitations
|
|
323
|
+
|
|
324
|
+
- Only tools listed as checked in [What is covered](#what-is-covered). User input, model output and tool results
|
|
325
|
+
are not checked.
|
|
326
|
+
- Calls from one model turn run in parallel. A denied call does not stop the others in the same turn.
|
|
327
|
+
- Defaults the model did not send are not evaluated.
|
|
328
|
+
- Middleware after the guard and tool-level middleware can change the call after the check (see
|
|
329
|
+
[Middleware order](#middleware-order)).
|
|
330
|
+
- Tested with `Agent.ask`, parallel calls in one model turn, toolkits, a local stdio MCP server, client tools, sub-agent tools, sub-tasks,
|
|
331
|
+
per-ask tools and middleware, and hosted tool calls reported by the provider, all with AG2's scripted test
|
|
332
|
+
model, against ag2 1.2.0 and the latest release. Real providers, AG2 networks, A2A, AG-UI and ACP transports are
|
|
333
|
+
not tested.
|
|
334
|
+
- `Constitution.default()` focuses on governance integrity (self-approval, skipping audits, privilege escalation)
|
|
335
|
+
and on secrets and personal data (`password`, `api_key`, `sk-...` and `ghp_...` tokens, US SSN
|
|
336
|
+
patterns). It does **not** cover destructive operations such as `rm -rf` or `DROP TABLE`. Write rules for the
|
|
337
|
+
tools you expose. `tests/test_default_constitution.py` lists what the default rules do and do not catch.
|
|
338
|
+
- Keyword rules in acgs-lite 3.0.1 match literal, case-insensitive substrings. They do not understand negation
|
|
339
|
+
("never share the password" matches `password`) and do not treat `-`, `_` and spaces as equivalent
|
|
340
|
+
(`api-key` does not match the keyword `api_key`).
|
|
341
|
+
- Because argument names are part of the evaluated text, a tool with a parameter named `password` is denied
|
|
342
|
+
under the default constitution whenever it is called.
|
|
343
|
+
- ag2 1.2.0 is the minimum because `ToolApprovalRequest` first shipped in it.
|
|
344
|
+
|
|
345
|
+
## Development
|
|
346
|
+
|
|
347
|
+
```bash
|
|
348
|
+
uv sync --group dev # or use hatch: hatch run prepare
|
|
349
|
+
hatch run format # ruff format + ruff check --fix
|
|
350
|
+
hatch run lint # ruff check + ruff format --check
|
|
351
|
+
hatch run typecheck # mypy --strict
|
|
352
|
+
hatch run cov # pytest with a 100% branch-coverage gate, network disabled
|
|
353
|
+
hatch run min:cov # the same tests against ag2 1.2.0 and acgs-lite 3.0.1
|
|
354
|
+
pre-commit install # format, lint, type check and tests on commit; commitizen on commit messages
|
|
355
|
+
```
|
|
356
|
+
|
|
357
|
+
Commit messages follow [Conventional Commits](https://www.conventionalcommits.org/); `cz bump` updates the version
|
|
358
|
+
and the changelog.
|
|
359
|
+
|
|
360
|
+
## License
|
|
361
|
+
|
|
362
|
+
Apache-2.0. See [LICENSE](LICENSE).
|