crewai-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.
- crewai_acgs-0.1.0/.gitignore +12 -0
- crewai_acgs-0.1.0/CHANGELOG.md +18 -0
- crewai_acgs-0.1.0/LICENSE +175 -0
- crewai_acgs-0.1.0/PKG-INFO +347 -0
- crewai_acgs-0.1.0/README.md +318 -0
- crewai_acgs-0.1.0/examples/quickstart.py +99 -0
- crewai_acgs-0.1.0/pyproject.toml +145 -0
- crewai_acgs-0.1.0/src/crewai_acgs/__init__.py +17 -0
- crewai_acgs-0.1.0/src/crewai_acgs/_governance.py +310 -0
- crewai_acgs-0.1.0/src/crewai_acgs/hooks.py +253 -0
- crewai_acgs-0.1.0/src/crewai_acgs/py.typed +0 -0
- crewai_acgs-0.1.0/tests/__init__.py +0 -0
- crewai_acgs-0.1.0/tests/conftest.py +27 -0
- crewai_acgs-0.1.0/tests/fakes.py +62 -0
- crewai_acgs-0.1.0/tests/test_default_constitution.py +90 -0
- crewai_acgs-0.1.0/tests/test_examples.py +46 -0
- crewai_acgs-0.1.0/tests/test_governance.py +286 -0
- crewai_acgs-0.1.0/tests/test_hooks.py +493 -0
- crewai_acgs-0.1.0/tests/test_imports.py +18 -0
|
@@ -0,0 +1,18 @@
|
|
|
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 (unreleased)
|
|
10
|
+
|
|
11
|
+
### Added
|
|
12
|
+
|
|
13
|
+
- `ACGSToolCallHook`, which registers CrewAI `PRE_TOOL_CALL` and `POST_TOOL_CALL` hooks that check each tool call
|
|
14
|
+
against an ACGS constitution. Denied calls raise `HookAborted`; the agent receives the ACGS reason as the tool
|
|
15
|
+
result.
|
|
16
|
+
- `on_review` (`"deny"`, `"human_input"` or a callable) for calls that only match review rules.
|
|
17
|
+
- Fail-closed handling: any error while evaluating or reviewing a call denies it.
|
|
18
|
+
- `format_tool_call`, the documented text representation of a tool call that ACGS rules are evaluated against.
|
|
@@ -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.
|
|
@@ -0,0 +1,347 @@
|
|
|
1
|
+
Metadata-Version: 2.5
|
|
2
|
+
Name: crewai-acgs
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: ACGS rule-based tool-call governance for CrewAI, as native tool call hooks
|
|
5
|
+
Project-URL: Homepage, https://github.com/acgs-ai/crewai-acgs
|
|
6
|
+
Project-URL: Documentation, https://github.com/acgs-ai/crewai-acgs#readme
|
|
7
|
+
Project-URL: Repository, https://github.com/acgs-ai/crewai-acgs
|
|
8
|
+
Project-URL: Issues, https://github.com/acgs-ai/crewai-acgs/issues
|
|
9
|
+
Project-URL: Changelog, https://github.com/acgs-ai/crewai-acgs/blob/main/CHANGELOG.md
|
|
10
|
+
Author: Martin Lyu
|
|
11
|
+
License-Expression: Apache-2.0
|
|
12
|
+
License-File: LICENSE
|
|
13
|
+
Keywords: acgs,agents,ai,crewai,governance,guardrails,hooks,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: Topic :: Scientific/Engineering :: Artificial Intelligence
|
|
23
|
+
Classifier: Typing :: Typed
|
|
24
|
+
Requires-Python: <3.14,>=3.10
|
|
25
|
+
Requires-Dist: acgs-lite<4,>=3.0.1
|
|
26
|
+
Requires-Dist: crewai<2,>=1.15.3
|
|
27
|
+
Requires-Dist: typing-extensions>=4.7.0
|
|
28
|
+
Description-Content-Type: text/markdown
|
|
29
|
+
|
|
30
|
+
# crewai-acgs
|
|
31
|
+
|
|
32
|
+
[](https://github.com/acgs-ai/crewai-acgs/actions/workflows/ci.yml)
|
|
33
|
+
[](https://pypi.org/project/crewai-acgs/)
|
|
34
|
+
[](https://pypi.org/project/crewai-acgs/)
|
|
35
|
+
|
|
36
|
+
`crewai-acgs` checks every CrewAI tool call against [ACGS](https://pypi.org/project/acgs-lite/) constitution
|
|
37
|
+
rules before the tool runs. It uses CrewAI's own
|
|
38
|
+
[tool call hooks](https://docs.crewai.com/v1.15.28/en/learn/tool-hooks) (`InterceptionPoint.PRE_TOOL_CALL` and
|
|
39
|
+
`POST_TOOL_CALL`), so agents, tasks, tools and crews stay unchanged.
|
|
40
|
+
|
|
41
|
+
- Calls that match no blocking rule run unchanged.
|
|
42
|
+
- Calls that match a blocking rule do not run. The hook raises `HookAborted`, CrewAI skips the tool, and the agent
|
|
43
|
+
receives the ACGS reason as the tool result and continues.
|
|
44
|
+
- Calls that only match review rules are denied by default, or sent to a person (`on_review="human_input"`) or to
|
|
45
|
+
your own approval function.
|
|
46
|
+
- Any error while evaluating or reviewing a call denies it (fail-closed).
|
|
47
|
+
|
|
48
|
+
The package is a thin adapter over the public `acgs-lite` API.
|
|
49
|
+
|
|
50
|
+
## Installation
|
|
51
|
+
|
|
52
|
+
```bash
|
|
53
|
+
pip install crewai-acgs
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
Requires Python 3.10 to 3.13, `crewai>=1.15.3` (the first release with `HookAborted` and the `@on` hook API) and
|
|
57
|
+
`acgs-lite>=3.0.1`.
|
|
58
|
+
|
|
59
|
+
## Usage
|
|
60
|
+
|
|
61
|
+
```python
|
|
62
|
+
from crewai_acgs import ACGSToolCallHook
|
|
63
|
+
|
|
64
|
+
gate = ACGSToolCallHook().register() # gates every tool call in this process
|
|
65
|
+
# ... crew.kickoff() ...
|
|
66
|
+
gate.unregister()
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
`ACGSToolCallHook` also works as a context manager (`with ACGSToolCallHook(): crew.kickoff()`), which registers the
|
|
70
|
+
hooks on entry and removes them on exit.
|
|
71
|
+
|
|
72
|
+
This complete example runs without an API key; a scripted model stands in for the LLM and prints each tool result
|
|
73
|
+
the agent receives:
|
|
74
|
+
|
|
75
|
+
```python
|
|
76
|
+
"""Gate CrewAI tool calls with ACGS. Runs offline: a scripted model stands in for the LLM."""
|
|
77
|
+
|
|
78
|
+
import json
|
|
79
|
+
from typing import Any
|
|
80
|
+
|
|
81
|
+
from acgs_lite import Constitution, Rule, Severity, ViolationAction
|
|
82
|
+
from crewai import Agent, Crew, Task
|
|
83
|
+
from crewai.hooks import ToolCallHookContext
|
|
84
|
+
from crewai.llms.base_llm import BaseLLM
|
|
85
|
+
from crewai.tools import tool
|
|
86
|
+
|
|
87
|
+
from crewai_acgs import ACGSToolCallHook, GovernanceDecision
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
class ScriptedLLM(BaseLLM):
|
|
91
|
+
"""Replays scripted tool calls, then answers. Prints each tool result the agent receives."""
|
|
92
|
+
|
|
93
|
+
replies: list[Any]
|
|
94
|
+
|
|
95
|
+
def call(self, messages: Any, *args: Any, **kwargs: Any) -> Any:
|
|
96
|
+
tool_results = [m for m in messages if isinstance(m, dict) and m.get("role") == "tool"]
|
|
97
|
+
if tool_results:
|
|
98
|
+
print(f"{tool_results[-1].get('name')}: {tool_results[-1]['content']}")
|
|
99
|
+
return self.replies.pop(0)
|
|
100
|
+
|
|
101
|
+
def supports_function_calling(self) -> bool:
|
|
102
|
+
return True
|
|
103
|
+
|
|
104
|
+
|
|
105
|
+
def call(name: str, **arguments: Any) -> list[dict[str, Any]]:
|
|
106
|
+
return [{"id": f"call-{name}", "function": {"name": name, "arguments": json.dumps(arguments)}}]
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
@tool("send_email")
|
|
110
|
+
def send_email(to: str, body: str) -> str:
|
|
111
|
+
"""Send an email."""
|
|
112
|
+
return f"Email sent to {to}"
|
|
113
|
+
|
|
114
|
+
|
|
115
|
+
@tool("get_weather")
|
|
116
|
+
def get_weather(city: str) -> str:
|
|
117
|
+
"""Get the weather for a city."""
|
|
118
|
+
return f"Sunny in {city}"
|
|
119
|
+
|
|
120
|
+
|
|
121
|
+
@tool("issue_refund")
|
|
122
|
+
def issue_refund(order_id: str, amount: float) -> str:
|
|
123
|
+
"""Refund an order."""
|
|
124
|
+
return f"Refunded {amount} for {order_id}"
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
def run(llm: ScriptedLLM, tools: list[Any]) -> None:
|
|
128
|
+
agent = Agent(role="Assistant", goal="Help the user", backstory="Uses tools when needed.", llm=llm, tools=tools)
|
|
129
|
+
task = Task(description="Help the user.", expected_output="A short answer.", agent=agent)
|
|
130
|
+
Crew(agents=[agent], tasks=[task]).kickoff()
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
# 1. The default constitution blocks the email that leaks a password; the weather lookup runs.
|
|
134
|
+
model = ScriptedLLM(
|
|
135
|
+
model="scripted",
|
|
136
|
+
replies=[
|
|
137
|
+
call("send_email", to="ops@example.com", body="The admin password is hunter2"),
|
|
138
|
+
call("get_weather", city="Paris"),
|
|
139
|
+
"Done.",
|
|
140
|
+
],
|
|
141
|
+
)
|
|
142
|
+
with ACGSToolCallHook():
|
|
143
|
+
run(model, [send_email, get_weather])
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
# 2. A review rule: refunds need approval. Here a function approves small refunds only.
|
|
147
|
+
refunds = Constitution.from_rules(
|
|
148
|
+
[
|
|
149
|
+
Rule(
|
|
150
|
+
id="REFUND-REVIEW",
|
|
151
|
+
text="Refunds need human approval",
|
|
152
|
+
severity=Severity.HIGH,
|
|
153
|
+
keywords=["refund"],
|
|
154
|
+
workflow_action=ViolationAction.REQUIRE_HUMAN_REVIEW,
|
|
155
|
+
)
|
|
156
|
+
],
|
|
157
|
+
name="refunds",
|
|
158
|
+
)
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
def approve_small_refunds(context: ToolCallHookContext, decision: GovernanceDecision) -> bool:
|
|
162
|
+
return float(context.tool_input["amount"]) <= 50
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
model = ScriptedLLM(
|
|
166
|
+
model="scripted",
|
|
167
|
+
replies=[
|
|
168
|
+
call("issue_refund", order_id="A-17", amount=20),
|
|
169
|
+
call("issue_refund", order_id="A-18", amount=500),
|
|
170
|
+
"Done.",
|
|
171
|
+
],
|
|
172
|
+
)
|
|
173
|
+
with ACGSToolCallHook(constitution=refunds, on_review=approve_small_refunds):
|
|
174
|
+
run(model, [issue_refund])
|
|
175
|
+
```
|
|
176
|
+
|
|
177
|
+
Output of `python examples/quickstart.py` (on its first run in a project, CrewAI may also print its own tracing
|
|
178
|
+
notice):
|
|
179
|
+
|
|
180
|
+
```text
|
|
181
|
+
send_email: Tool call 'send_email' was not executed. Blocked by ACGS rule ACGS-006 (Agents must not expose sensitive data in responses).
|
|
182
|
+
get_weather: Sunny in Paris
|
|
183
|
+
issue_refund: Refunded 20.0 for A-17
|
|
184
|
+
issue_refund: Tool call 'issue_refund' was not executed. Human review did not approve the call. Human review required by ACGS rule REFUND-REVIEW (Refunds need human approval).
|
|
185
|
+
```
|
|
186
|
+
|
|
187
|
+
## How a tool call is evaluated
|
|
188
|
+
|
|
189
|
+
1. `ToolCallHookContext.tool_name` and `tool_input` are rendered as text by `format_tool_call`:
|
|
190
|
+
|
|
191
|
+
```python
|
|
192
|
+
from crewai_acgs import format_tool_call
|
|
193
|
+
|
|
194
|
+
print(format_tool_call("update_config", {"service": "billing", "change": "disable\nlogging", "dryRun": False}))
|
|
195
|
+
```
|
|
196
|
+
|
|
197
|
+
```text
|
|
198
|
+
tool: update_config
|
|
199
|
+
arguments:
|
|
200
|
+
change: disable logging
|
|
201
|
+
dryRun: false
|
|
202
|
+
service: billing
|
|
203
|
+
normalized: update config | dry run
|
|
204
|
+
```
|
|
205
|
+
|
|
206
|
+
Each argument leaf is one `path: value` line (nested values use `a.b[0].c` paths), so both argument names and
|
|
207
|
+
values are visible to rules. Whitespace inside values is collapsed so phrases split across lines still match.
|
|
208
|
+
Identifiers written in `snake_case`, `kebab-case` or `camelCase` (the tool name, argument names, and
|
|
209
|
+
single-token string values) are repeated as plain words on the `normalized:` line, so the keyword
|
|
210
|
+
`skip audit` also matches a tool called `skip_audit`. Nothing is truncated.
|
|
211
|
+
Pass `tool_call_formatter=` to use a different representation.
|
|
212
|
+
|
|
213
|
+
2. The text is validated with `acgs_lite.GovernanceEngine.validate` against the constitution
|
|
214
|
+
(`Constitution.default()` unless you pass one).
|
|
215
|
+
|
|
216
|
+
3. The result decides what happens to the call:
|
|
217
|
+
|
|
218
|
+
| ACGS outcome | Result |
|
|
219
|
+
|---|---|
|
|
220
|
+
| No blocking rule matched (warn-only rules may match) | The tool runs |
|
|
221
|
+
| Only `require_human_review` / `escalate_to_senior` rules matched | Review (see below); denied by default |
|
|
222
|
+
| Any `block`, `block_and_notify` or `halt_and_alert` rule matched | Denied |
|
|
223
|
+
| A rule ID not found in the constitution, or an invalid result without a rule | Denied |
|
|
224
|
+
| Any exception while reading, evaluating or reviewing the tool call | Denied (fail-closed) |
|
|
225
|
+
|
|
226
|
+
A matched blocking rule is never downgraded to review because a review rule matched as well.
|
|
227
|
+
The denial reason then lists only the blocking rules after "Blocked by" and names the matched review
|
|
228
|
+
rules separately.
|
|
229
|
+
|
|
230
|
+
A denied call raises `HookAborted(reason, source="crewai-acgs")`, so CrewAI does not run the tool and records the
|
|
231
|
+
reason and source on its `HookDispatchedEvent`. CrewAI then gives the agent the generic result
|
|
232
|
+
`"Tool execution blocked by hook. Tool: <name>"`; the hook's `POST_TOOL_CALL` half replaces it with
|
|
233
|
+
`"Tool call '<name>' was not executed. <reason>"` so the model can adjust. The reason names the matched rules but
|
|
234
|
+
never repeats argument values. Exceptions raised by the tool itself are reported by CrewAI as usual.
|
|
235
|
+
|
|
236
|
+
CrewAI ignores exceptions other than `HookAborted` that a hook raises and then runs the tool anyway. The hook
|
|
237
|
+
therefore catches every error itself and turns it into a denial.
|
|
238
|
+
|
|
239
|
+
`ACGSToolCallHook.evaluate(tool_name, args)` returns the underlying `GovernanceDecision`
|
|
240
|
+
(`verdict`, `reason`, `rule_ids`, `warning_rule_ids`, `error`) without running anything.
|
|
241
|
+
|
|
242
|
+
## Review
|
|
243
|
+
|
|
244
|
+
CrewAI has no built-in way to pause a run and resume it later after an approval. The `on_review` option decides
|
|
245
|
+
what happens to calls that only match review rules:
|
|
246
|
+
|
|
247
|
+
| `on_review` | Behaviour |
|
|
248
|
+
|---|---|
|
|
249
|
+
| `"deny"` (default) | The call is denied with the review reason. Works in unattended runs. |
|
|
250
|
+
| `"human_input"` | Asks in the terminal with CrewAI's `ToolCallHookContext.request_human_input`, showing the reason and the arguments. Only `y` or `yes` (any case) runs the call; any other answer denies it. If no terminal is available (`EOFError`), the call is denied. |
|
|
251
|
+
| a callable `(context, decision) -> bool` | Your function decides, for example by calling an approval service. Only a return value of exactly `True` runs the call; other values and exceptions deny it. |
|
|
252
|
+
|
|
253
|
+
```python
|
|
254
|
+
from crewai_acgs import ACGSToolCallHook
|
|
255
|
+
|
|
256
|
+
terminal_review = ACGSToolCallHook(on_review="human_input")
|
|
257
|
+
own_review = ACGSToolCallHook(on_review=lambda context, decision: context.tool_name == "issue_refund")
|
|
258
|
+
```
|
|
259
|
+
|
|
260
|
+
`"human_input"` blocks the tool call until someone answers, so use it only for interactive runs. Hooks run
|
|
261
|
+
synchronously, including inside `kickoff_async`.
|
|
262
|
+
|
|
263
|
+
## Registration
|
|
264
|
+
|
|
265
|
+
CrewAI tool call hooks are global to the Python process: once registered, the hook gates every crew and every
|
|
266
|
+
agent until it is removed. `register()` adds both hooks (calling it again has no effect), `unregister()` removes
|
|
267
|
+
them, and `is_registered` reports whether both are active. `crewai.hooks.clear_all_hooks()` removes them too.
|
|
268
|
+
|
|
269
|
+
CrewAI runs hooks in registration order and stops at the first one that blocks. Register `ACGSToolCallHook` after
|
|
270
|
+
any hook that changes `tool_input`, so that ACGS evaluates the input the tool actually receives. A hook registered
|
|
271
|
+
later that changes `tool_input` would run after ACGS has allowed the call.
|
|
272
|
+
|
|
273
|
+
Several instances can be registered at the same time (for example a general and a domain-specific constitution).
|
|
274
|
+
A call runs only if every instance allows it.
|
|
275
|
+
|
|
276
|
+
## Custom constitutions
|
|
277
|
+
|
|
278
|
+
```python
|
|
279
|
+
from acgs_lite import Constitution, Rule, Severity, ViolationAction
|
|
280
|
+
|
|
281
|
+
from crewai_acgs import ACGSToolCallHook
|
|
282
|
+
|
|
283
|
+
constitution = Constitution.from_rules(
|
|
284
|
+
[
|
|
285
|
+
Rule(
|
|
286
|
+
id="NO-DESTRUCTIVE-SQL",
|
|
287
|
+
text="No destructive SQL",
|
|
288
|
+
severity=Severity.CRITICAL,
|
|
289
|
+
keywords=["drop table", "truncate table"],
|
|
290
|
+
),
|
|
291
|
+
Rule(
|
|
292
|
+
id="REFUND-REVIEW",
|
|
293
|
+
text="Refunds need approval",
|
|
294
|
+
severity=Severity.HIGH,
|
|
295
|
+
keywords=["refund"],
|
|
296
|
+
workflow_action=ViolationAction.REQUIRE_HUMAN_REVIEW,
|
|
297
|
+
),
|
|
298
|
+
],
|
|
299
|
+
name="payments",
|
|
300
|
+
)
|
|
301
|
+
gate = ACGSToolCallHook(constitution=constitution, agent_id="payments-crew")
|
|
302
|
+
```
|
|
303
|
+
|
|
304
|
+
`Constitution.from_yaml("rules.yaml")` works as well.
|
|
305
|
+
|
|
306
|
+
## Options
|
|
307
|
+
|
|
308
|
+
| Argument | Default | Meaning |
|
|
309
|
+
|---|---|---|
|
|
310
|
+
| `constitution` | `Constitution.default()` | Rules to enforce |
|
|
311
|
+
| `agent_id` | `"crewai-agent"` | Agent identifier recorded by ACGS |
|
|
312
|
+
| `on_review` | `"deny"` | `"deny"`, `"human_input"`, or a callable `(context, decision) -> bool` |
|
|
313
|
+
| `tool_call_formatter` | `format_tool_call` | `(tool_name, args) -> str` used as the evaluated text |
|
|
314
|
+
|
|
315
|
+
## Limitations
|
|
316
|
+
|
|
317
|
+
- Only tool calls are checked. Model input and output, and tool results, are not.
|
|
318
|
+
- Tested with `Crew.kickoff` (ReAct text loop and native tool calling, including parallel native calls),
|
|
319
|
+
`Crew.kickoff_async` and `Agent.kickoff`, against crewai 1.15.3 and the latest release.
|
|
320
|
+
- `Constitution.default()` focuses on governance integrity (self-approval, skipping audits, privilege escalation)
|
|
321
|
+
and on secrets and personal data (`password`, `api_key`, `sk-...` and `ghp_...` tokens, US SSN
|
|
322
|
+
patterns). It does **not** cover destructive operations such as `rm -rf` or `DROP TABLE`. Write rules for the
|
|
323
|
+
tools you expose. `tests/test_default_constitution.py` lists what the default rules do and do not catch.
|
|
324
|
+
- Keyword rules in acgs-lite 3.0.1 match literal, case-insensitive substrings. They do not understand negation
|
|
325
|
+
("never share the password" matches `password`) and do not treat `-`, `_` and spaces as equivalent
|
|
326
|
+
(`api-key` does not match the keyword `api_key`).
|
|
327
|
+
- Because argument names are part of the evaluated text, a tool with a parameter named `password` is denied under
|
|
328
|
+
the default constitution whenever it is called.
|
|
329
|
+
|
|
330
|
+
## Development
|
|
331
|
+
|
|
332
|
+
```bash
|
|
333
|
+
uv sync --group dev # or use hatch: hatch run prepare
|
|
334
|
+
hatch run format # ruff format + ruff check --fix
|
|
335
|
+
hatch run lint # ruff check + ruff format --check
|
|
336
|
+
hatch run typecheck # mypy --strict
|
|
337
|
+
hatch run cov # pytest with a 100% branch-coverage gate, network disabled
|
|
338
|
+
hatch run min:cov # the same tests against crewai 1.15.3 and acgs-lite 3.0.1
|
|
339
|
+
pre-commit install # format, lint, type check and tests on commit; commitizen on commit messages
|
|
340
|
+
```
|
|
341
|
+
|
|
342
|
+
Commit messages follow [Conventional Commits](https://www.conventionalcommits.org/); `cz bump` updates the version
|
|
343
|
+
and the changelog.
|
|
344
|
+
|
|
345
|
+
## License
|
|
346
|
+
|
|
347
|
+
Apache-2.0. See [LICENSE](LICENSE).
|