concordat 0.0.1__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.
- concordat-0.0.1/.github/workflows/ci.yml +22 -0
- concordat-0.0.1/.github/workflows/publish.yml +27 -0
- concordat-0.0.1/.gitignore +9 -0
- concordat-0.0.1/LICENSE +202 -0
- concordat-0.0.1/PKG-INFO +143 -0
- concordat-0.0.1/README.md +114 -0
- concordat-0.0.1/docs/design.md +133 -0
- concordat-0.0.1/examples/refund.py +40 -0
- concordat-0.0.1/pyproject.toml +59 -0
- concordat-0.0.1/src/concordat/__init__.py +24 -0
- concordat-0.0.1/src/concordat/_runner.py +105 -0
- concordat-0.0.1/src/concordat/agent.py +197 -0
- concordat-0.0.1/src/concordat/anthropic.py +126 -0
- concordat-0.0.1/src/concordat/budget.py +41 -0
- concordat-0.0.1/src/concordat/openai.py +125 -0
- concordat-0.0.1/src/concordat/protocol.py +78 -0
- concordat-0.0.1/src/concordat/py.typed +0 -0
- concordat-0.0.1/src/concordat/session.py +46 -0
- concordat-0.0.1/tests/test_agent.py +162 -0
- concordat-0.0.1/tests/test_anthropic.py +206 -0
- concordat-0.0.1/tests/test_budget.py +41 -0
- concordat-0.0.1/tests/test_openai.py +161 -0
- concordat-0.0.1/tests/test_protocol.py +50 -0
- concordat-0.0.1/tests/test_session.py +43 -0
- concordat-0.0.1/uv.lock +995 -0
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
name: CI
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
branches: [main]
|
|
6
|
+
pull_request:
|
|
7
|
+
|
|
8
|
+
jobs:
|
|
9
|
+
test:
|
|
10
|
+
runs-on: ubuntu-latest
|
|
11
|
+
strategy:
|
|
12
|
+
matrix:
|
|
13
|
+
python: ["3.10", "3.11", "3.12", "3.13"]
|
|
14
|
+
steps:
|
|
15
|
+
- uses: actions/checkout@v4
|
|
16
|
+
- uses: astral-sh/setup-uv@v6
|
|
17
|
+
with:
|
|
18
|
+
python-version: ${{ matrix.python }}
|
|
19
|
+
- run: uv sync
|
|
20
|
+
- run: uv run ruff check
|
|
21
|
+
- run: uv run mypy src
|
|
22
|
+
- run: uv run pytest
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
name: Publish
|
|
2
|
+
|
|
3
|
+
# Runs when a GitHub release is published. Uses PyPI trusted publishing:
|
|
4
|
+
# no API token is stored anywhere; PyPI trusts this workflow directly.
|
|
5
|
+
on:
|
|
6
|
+
release:
|
|
7
|
+
types: [published]
|
|
8
|
+
|
|
9
|
+
jobs:
|
|
10
|
+
publish:
|
|
11
|
+
runs-on: ubuntu-latest
|
|
12
|
+
environment: pypi
|
|
13
|
+
permissions:
|
|
14
|
+
id-token: write # lets PyPI verify this workflow's identity
|
|
15
|
+
contents: read
|
|
16
|
+
steps:
|
|
17
|
+
- uses: actions/checkout@v4
|
|
18
|
+
- uses: astral-sh/setup-uv@v6
|
|
19
|
+
- name: Check the release tag matches the package version
|
|
20
|
+
run: |
|
|
21
|
+
version=$(uv version --short)
|
|
22
|
+
test "${GITHUB_REF_NAME}" = "v${version}" || {
|
|
23
|
+
echo "Tag ${GITHUB_REF_NAME} does not match package version v${version}"; exit 1; }
|
|
24
|
+
- run: uv sync
|
|
25
|
+
- run: uv run pytest
|
|
26
|
+
- run: uv build
|
|
27
|
+
- run: uv publish
|
concordat-0.0.1/LICENSE
ADDED
|
@@ -0,0 +1,202 @@
|
|
|
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.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
concordat-0.0.1/PKG-INFO
ADDED
|
@@ -0,0 +1,143 @@
|
|
|
1
|
+
Metadata-Version: 2.5
|
|
2
|
+
Name: concordat
|
|
3
|
+
Version: 0.0.1
|
|
4
|
+
Summary: Typed sessions for AI agents: protocols the runtime enforces on the model.
|
|
5
|
+
Project-URL: Homepage, https://github.com/miladsikaroudi/concordat
|
|
6
|
+
Project-URL: Repository, https://github.com/miladsikaroudi/concordat
|
|
7
|
+
Project-URL: Issues, https://github.com/miladsikaroudi/concordat/issues
|
|
8
|
+
Project-URL: Documentation, https://github.com/miladsikaroudi/concordat/blob/main/docs/design.md
|
|
9
|
+
Author: miladsikaroudi
|
|
10
|
+
License-Expression: Apache-2.0
|
|
11
|
+
License-File: LICENSE
|
|
12
|
+
Keywords: agents,claude,llm,openai,protocols,session types,typestate
|
|
13
|
+
Classifier: Development Status :: 2 - Pre-Alpha
|
|
14
|
+
Classifier: Intended Audience :: Developers
|
|
15
|
+
Classifier: Operating System :: OS Independent
|
|
16
|
+
Classifier: Programming Language :: Python :: 3
|
|
17
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
18
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
19
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
20
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
21
|
+
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
|
|
22
|
+
Classifier: Typing :: Typed
|
|
23
|
+
Requires-Python: >=3.10
|
|
24
|
+
Provides-Extra: anthropic
|
|
25
|
+
Requires-Dist: anthropic<2,>=1.12; extra == 'anthropic'
|
|
26
|
+
Provides-Extra: openai
|
|
27
|
+
Requires-Dist: openai<4,>=3.26; extra == 'openai'
|
|
28
|
+
Description-Content-Type: text/markdown
|
|
29
|
+
|
|
30
|
+
# concordat
|
|
31
|
+
|
|
32
|
+
**Typed sessions for AI agents.** Agents are objects whose interfaces are protocols,
|
|
33
|
+
and the runtime enforces those protocols on the model.
|
|
34
|
+
|
|
35
|
+
> Status: pre-alpha. Agent classes, the protocol/session/budget kernel, and runners for
|
|
36
|
+
> Claude (Anthropic) and OpenAI work. See [docs/design.md](https://github.com/miladsikaroudi/concordat/blob/main/docs/design.md).
|
|
37
|
+
|
|
38
|
+
## Why
|
|
39
|
+
|
|
40
|
+
"Never refund before verifying identity" usually lives in a prompt and is hoped for.
|
|
41
|
+
Concordat makes it a checked protocol:
|
|
42
|
+
|
|
43
|
+
- **Protocol fidelity:** the session follows the declared order of turns.
|
|
44
|
+
- **Least privilege per step:** the model only gets the tools legal in the current state.
|
|
45
|
+
- **Bounded spend:** tokens, tool calls and dollars stay within budget, even across handoffs.
|
|
46
|
+
|
|
47
|
+
## Example
|
|
48
|
+
|
|
49
|
+
```python
|
|
50
|
+
from concordat import Agent, Budget, human, tool
|
|
51
|
+
|
|
52
|
+
class RefundAgent(Agent):
|
|
53
|
+
final = {"refunded", "denied"}
|
|
54
|
+
budget = Budget(tool_calls=10)
|
|
55
|
+
|
|
56
|
+
@tool(when="start", then={True: "verified", False: "denied"})
|
|
57
|
+
def verify_identity(self, user_id: str) -> bool:
|
|
58
|
+
return lookup(user_id).verified
|
|
59
|
+
|
|
60
|
+
@tool(when="verified", then="awaiting_approval")
|
|
61
|
+
def propose_refund(self, amount: float) -> float:
|
|
62
|
+
return amount
|
|
63
|
+
|
|
64
|
+
@human(when="awaiting_approval", approve="refunded", reject="denied")
|
|
65
|
+
def approve_refund(self, amount: float) -> str:
|
|
66
|
+
return f"Refund ${amount}?" # shown to the human approver
|
|
67
|
+
|
|
68
|
+
agent = RefundAgent() # protocol already checked when the class was defined
|
|
69
|
+
agent.allowed_tools() # {'verify_identity': ...}: all the model gets to see
|
|
70
|
+
agent.propose_refund(5000) # ProtocolViolation, raised before the body runs
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
### Running it with Claude
|
|
74
|
+
|
|
75
|
+
```bash
|
|
76
|
+
pip install "concordat[anthropic]"
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
```python
|
|
80
|
+
import anthropic
|
|
81
|
+
from concordat.anthropic import run
|
|
82
|
+
|
|
83
|
+
result = run(RefundAgent(), anthropic.Anthropic(), "Please refund order A-100.")
|
|
84
|
+
result.status # "done", or "waiting" if Claude asked the user something
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
Each turn Claude is offered only the actions legal in the current state (a human
|
|
88
|
+
step appears as a request that only the approver can decide), one call per
|
|
89
|
+
response. Every response's tokens are charged to the agent's budget, and the next
|
|
90
|
+
response is capped to what is left. Illegal or invalid calls go back to Claude as
|
|
91
|
+
errors so it can correct itself. See [examples/refund.py](https://github.com/miladsikaroudi/concordat/blob/main/examples/refund.py).
|
|
92
|
+
|
|
93
|
+
### Running it with OpenAI
|
|
94
|
+
|
|
95
|
+
The same loop over the Responses API (`pip install "concordat[openai]"`):
|
|
96
|
+
|
|
97
|
+
```python
|
|
98
|
+
import openai
|
|
99
|
+
from concordat.openai import run
|
|
100
|
+
|
|
101
|
+
result = run(RefundAgent(), openai.OpenAI(), "Please refund order A-100.", model="...")
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
### Without classes
|
|
105
|
+
|
|
106
|
+
The same protocol, using the kernel directly:
|
|
107
|
+
|
|
108
|
+
```python
|
|
109
|
+
from concordat import Budget, Protocol, Session
|
|
110
|
+
|
|
111
|
+
refund = Protocol(
|
|
112
|
+
"start",
|
|
113
|
+
{
|
|
114
|
+
"start": {"verify_identity": {"verified", "denied"}},
|
|
115
|
+
"verified": {"propose_refund": {"awaiting_approval"}},
|
|
116
|
+
"awaiting_approval": {"human.approve": {"refunded"}, "human.reject": {"denied"}},
|
|
117
|
+
},
|
|
118
|
+
final={"refunded", "denied"},
|
|
119
|
+
) # checked here: no dead ends, no unreachable states
|
|
120
|
+
|
|
121
|
+
session = Session(refund, Budget(tokens=50_000, tool_calls=10))
|
|
122
|
+
session.allowed_actions() # {'verify_identity'}: only these tools go to the model
|
|
123
|
+
session.step("propose_refund") # ProtocolViolation: not allowed in state 'start'
|
|
124
|
+
```
|
|
125
|
+
|
|
126
|
+
Handing work to another agent splits the budget, and the parent can't spend it twice:
|
|
127
|
+
|
|
128
|
+
```python
|
|
129
|
+
child_budget = session.budget.split(tokens=10_000, tool_calls=3)
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
## Development
|
|
133
|
+
|
|
134
|
+
```bash
|
|
135
|
+
uv sync
|
|
136
|
+
uv run pytest
|
|
137
|
+
uv run mypy src
|
|
138
|
+
uv run ruff check
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
## License
|
|
142
|
+
|
|
143
|
+
Apache-2.0
|
|
@@ -0,0 +1,114 @@
|
|
|
1
|
+
# concordat
|
|
2
|
+
|
|
3
|
+
**Typed sessions for AI agents.** Agents are objects whose interfaces are protocols,
|
|
4
|
+
and the runtime enforces those protocols on the model.
|
|
5
|
+
|
|
6
|
+
> Status: pre-alpha. Agent classes, the protocol/session/budget kernel, and runners for
|
|
7
|
+
> Claude (Anthropic) and OpenAI work. See [docs/design.md](https://github.com/miladsikaroudi/concordat/blob/main/docs/design.md).
|
|
8
|
+
|
|
9
|
+
## Why
|
|
10
|
+
|
|
11
|
+
"Never refund before verifying identity" usually lives in a prompt and is hoped for.
|
|
12
|
+
Concordat makes it a checked protocol:
|
|
13
|
+
|
|
14
|
+
- **Protocol fidelity:** the session follows the declared order of turns.
|
|
15
|
+
- **Least privilege per step:** the model only gets the tools legal in the current state.
|
|
16
|
+
- **Bounded spend:** tokens, tool calls and dollars stay within budget, even across handoffs.
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
```python
|
|
21
|
+
from concordat import Agent, Budget, human, tool
|
|
22
|
+
|
|
23
|
+
class RefundAgent(Agent):
|
|
24
|
+
final = {"refunded", "denied"}
|
|
25
|
+
budget = Budget(tool_calls=10)
|
|
26
|
+
|
|
27
|
+
@tool(when="start", then={True: "verified", False: "denied"})
|
|
28
|
+
def verify_identity(self, user_id: str) -> bool:
|
|
29
|
+
return lookup(user_id).verified
|
|
30
|
+
|
|
31
|
+
@tool(when="verified", then="awaiting_approval")
|
|
32
|
+
def propose_refund(self, amount: float) -> float:
|
|
33
|
+
return amount
|
|
34
|
+
|
|
35
|
+
@human(when="awaiting_approval", approve="refunded", reject="denied")
|
|
36
|
+
def approve_refund(self, amount: float) -> str:
|
|
37
|
+
return f"Refund ${amount}?" # shown to the human approver
|
|
38
|
+
|
|
39
|
+
agent = RefundAgent() # protocol already checked when the class was defined
|
|
40
|
+
agent.allowed_tools() # {'verify_identity': ...}: all the model gets to see
|
|
41
|
+
agent.propose_refund(5000) # ProtocolViolation, raised before the body runs
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
### Running it with Claude
|
|
45
|
+
|
|
46
|
+
```bash
|
|
47
|
+
pip install "concordat[anthropic]"
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
```python
|
|
51
|
+
import anthropic
|
|
52
|
+
from concordat.anthropic import run
|
|
53
|
+
|
|
54
|
+
result = run(RefundAgent(), anthropic.Anthropic(), "Please refund order A-100.")
|
|
55
|
+
result.status # "done", or "waiting" if Claude asked the user something
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
Each turn Claude is offered only the actions legal in the current state (a human
|
|
59
|
+
step appears as a request that only the approver can decide), one call per
|
|
60
|
+
response. Every response's tokens are charged to the agent's budget, and the next
|
|
61
|
+
response is capped to what is left. Illegal or invalid calls go back to Claude as
|
|
62
|
+
errors so it can correct itself. See [examples/refund.py](https://github.com/miladsikaroudi/concordat/blob/main/examples/refund.py).
|
|
63
|
+
|
|
64
|
+
### Running it with OpenAI
|
|
65
|
+
|
|
66
|
+
The same loop over the Responses API (`pip install "concordat[openai]"`):
|
|
67
|
+
|
|
68
|
+
```python
|
|
69
|
+
import openai
|
|
70
|
+
from concordat.openai import run
|
|
71
|
+
|
|
72
|
+
result = run(RefundAgent(), openai.OpenAI(), "Please refund order A-100.", model="...")
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
### Without classes
|
|
76
|
+
|
|
77
|
+
The same protocol, using the kernel directly:
|
|
78
|
+
|
|
79
|
+
```python
|
|
80
|
+
from concordat import Budget, Protocol, Session
|
|
81
|
+
|
|
82
|
+
refund = Protocol(
|
|
83
|
+
"start",
|
|
84
|
+
{
|
|
85
|
+
"start": {"verify_identity": {"verified", "denied"}},
|
|
86
|
+
"verified": {"propose_refund": {"awaiting_approval"}},
|
|
87
|
+
"awaiting_approval": {"human.approve": {"refunded"}, "human.reject": {"denied"}},
|
|
88
|
+
},
|
|
89
|
+
final={"refunded", "denied"},
|
|
90
|
+
) # checked here: no dead ends, no unreachable states
|
|
91
|
+
|
|
92
|
+
session = Session(refund, Budget(tokens=50_000, tool_calls=10))
|
|
93
|
+
session.allowed_actions() # {'verify_identity'}: only these tools go to the model
|
|
94
|
+
session.step("propose_refund") # ProtocolViolation: not allowed in state 'start'
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
Handing work to another agent splits the budget, and the parent can't spend it twice:
|
|
98
|
+
|
|
99
|
+
```python
|
|
100
|
+
child_budget = session.budget.split(tokens=10_000, tool_calls=3)
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
## Development
|
|
104
|
+
|
|
105
|
+
```bash
|
|
106
|
+
uv sync
|
|
107
|
+
uv run pytest
|
|
108
|
+
uv run mypy src
|
|
109
|
+
uv run ruff check
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
## License
|
|
113
|
+
|
|
114
|
+
Apache-2.0
|
|
@@ -0,0 +1,133 @@
|
|
|
1
|
+
# Concordat — design (v0.1)
|
|
2
|
+
|
|
3
|
+
*Typed sessions for AI agents: agents are objects whose interfaces are protocols,
|
|
4
|
+
and the runtime enforces those protocols on the model.*
|
|
5
|
+
|
|
6
|
+
## Problem
|
|
7
|
+
|
|
8
|
+
Agent frameworks let a model call any tool, in any order, at any cost, and check
|
|
9
|
+
policy afterwards (if at all). "Never refund before verifying identity" lives in a
|
|
10
|
+
prompt and is hoped for. Real deployments need three guarantees the prompt cannot
|
|
11
|
+
give:
|
|
12
|
+
|
|
13
|
+
1. **Protocol fidelity** — the conversation follows a declared order of turns.
|
|
14
|
+
2. **Least privilege per step** — the model only sees the tools that are legal *now*.
|
|
15
|
+
3. **Bounded spend** — tokens, tool calls and money stay within a declared budget,
|
|
16
|
+
including across handoffs to other agents.
|
|
17
|
+
|
|
18
|
+
## Idea
|
|
19
|
+
|
|
20
|
+
Borrow the object-oriented model developers already know, and give it the
|
|
21
|
+
discipline of session types / typestate:
|
|
22
|
+
|
|
23
|
+
| OOP | Concordat |
|
|
24
|
+
|---|---|
|
|
25
|
+
| class | agent template: protocol + instructions + tools + budget |
|
|
26
|
+
| object | a live `Session` with its own state |
|
|
27
|
+
| interface | a `Protocol`: states and the actions legal in each |
|
|
28
|
+
| method | a tool or turn, callable only in certain states |
|
|
29
|
+
| composition | handoff: delegate a sub-session with a slice of the budget |
|
|
30
|
+
|
|
31
|
+
Unlike an ordinary object, the implementation (the model) can't be trusted to keep
|
|
32
|
+
its interface. So the protocol is not documentation — it is enforced on every turn.
|
|
33
|
+
|
|
34
|
+
## Core concepts
|
|
35
|
+
|
|
36
|
+
- **Protocol** — a finite state machine: an initial state, final states, and for
|
|
37
|
+
each state the actions allowed and the states each action may lead to. Checked
|
|
38
|
+
when it is defined: no undefined states, no unreachable states, and every state
|
|
39
|
+
can still reach a final state (no dead ends).
|
|
40
|
+
- **Action** — a tool call, a model turn, or a human decision (`human.approve`).
|
|
41
|
+
Humans are just another party with actions in the protocol.
|
|
42
|
+
- **Session** — a protocol instance. It tracks the current state, exposes
|
|
43
|
+
`allowed_actions()`, and rejects anything else with `ProtocolViolation`.
|
|
44
|
+
- **Budget** — tokens, tool calls and USD. Spending is checked; `split()` carves
|
|
45
|
+
out a child budget and removes it from the parent (linear: it can't be spent twice).
|
|
46
|
+
- **Handoff** — starting a child session on another agent with a split budget; the
|
|
47
|
+
parent stays in a waiting state until the child finishes.
|
|
48
|
+
|
|
49
|
+
## Enforcement, per turn
|
|
50
|
+
|
|
51
|
+
On each model turn the runtime derives from the current state:
|
|
52
|
+
|
|
53
|
+
1. the **tool list** passed to the provider (only allowed actions), and
|
|
54
|
+
2. the **output schema** (structured output / grammar) for that state, and
|
|
55
|
+
3. the **remaining budget** (max tokens, stop if exhausted).
|
|
56
|
+
|
|
57
|
+
Then a **monitor** validates whatever comes back before any side effect runs.
|
|
58
|
+
Layer 1–2 prevent most violations; layer 3 catches the rest, so it works even with
|
|
59
|
+
providers that offer no decoding control.
|
|
60
|
+
|
|
61
|
+
## Agent classes
|
|
62
|
+
|
|
63
|
+
```python
|
|
64
|
+
class RefundAgent(Agent):
|
|
65
|
+
final = {"refunded", "denied"} # initial state defaults to "start"
|
|
66
|
+
budget = Budget(tokens=50_000, tool_calls=10)
|
|
67
|
+
|
|
68
|
+
@tool(when="start", then={True: "verified", False: "denied"})
|
|
69
|
+
def verify_identity(self, user_id: str) -> bool: ...
|
|
70
|
+
|
|
71
|
+
@tool(when="verified", then="awaiting_approval")
|
|
72
|
+
def propose_refund(self, amount: float) -> Proposal: ...
|
|
73
|
+
|
|
74
|
+
@human(when="awaiting_approval", approve="refunded", reject="denied")
|
|
75
|
+
def approve_refund(self, proposal: Proposal) -> str:
|
|
76
|
+
return f"Refund {proposal.amount}?" # shown to the approver
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
- The decorators compile to a `Protocol`, checked when the class is defined; a bad
|
|
80
|
+
protocol is a `ProtocolError` at import time.
|
|
81
|
+
- Declaring `final` makes a class concrete. Classes without it are abstract bases,
|
|
82
|
+
so protocols can be specialised by inheritance.
|
|
83
|
+
- Calling a tool outside its state raises `ProtocolViolation` *before* the body
|
|
84
|
+
runs. Each call charges one tool call to the instance's own copy of the budget.
|
|
85
|
+
- `then` is a single next state, or a mapping from the method's return value to the
|
|
86
|
+
next state. Branching is chosen by the tool result, or by which of several
|
|
87
|
+
allowed tools the model calls.
|
|
88
|
+
- `@human` steps can be *requested* by the model but only *decided* by the agent's
|
|
89
|
+
`approver`, which receives the method's return value. Offering the request keeps
|
|
90
|
+
the model from stalling in a state where only a human can move the protocol on.
|
|
91
|
+
- `instructions` is the agent's system prompt.
|
|
92
|
+
- Decorated methods keep their signatures for type checkers.
|
|
93
|
+
|
|
94
|
+
## Scope
|
|
95
|
+
|
|
96
|
+
**v0.1 (this milestone)**
|
|
97
|
+
- `Protocol`, `Session`, `Budget` kernel with definition-time checks — *done*
|
|
98
|
+
- `Agent` class with `@tool` / `@human` decorators — *done (sync only)*
|
|
99
|
+
- Async tools and approvers
|
|
100
|
+
- Anthropic runner (`concordat.anthropic.run`): allowed tools per state, one call
|
|
101
|
+
per response, token charging with per-response caps, refusal fallbacks — *done*
|
|
102
|
+
- OpenAI runner (`concordat.openai.run`, Responses API) — *done*
|
|
103
|
+
- Output schema per state (structured outputs), beyond tool arguments
|
|
104
|
+
- Human approval connector (CLI first)
|
|
105
|
+
- Showcase: a τ³-bench airline or retail domain, typed vs. untyped agent
|
|
106
|
+
|
|
107
|
+
**Later**
|
|
108
|
+
- Open models via llguidance / XGrammar (true grammar-constrained decoding)
|
|
109
|
+
- Multiparty protocols projected to per-agent views
|
|
110
|
+
- Durable sessions (journal + resume, possibly on Temporal / Restate / DBOS)
|
|
111
|
+
- TypeScript port
|
|
112
|
+
|
|
113
|
+
**Non-goals**
|
|
114
|
+
- Replacing agent frameworks. Concordat should sit inside them.
|
|
115
|
+
- Proving model outputs are *correct* — only that they are *allowed*.
|
|
116
|
+
|
|
117
|
+
## Related work
|
|
118
|
+
|
|
119
|
+
- **ZipperGen** (Bollig, Függer, Nowak, 2026) — projects message-sequence-chart
|
|
120
|
+
workflows to deadlock-free agent programs; durable replay. Concordat differs by
|
|
121
|
+
constraining the model's turns from the protocol state, budgets, and delegation.
|
|
122
|
+
- **XFlow / XPF** (2026) — protocol state gates tools and human approvals at
|
|
123
|
+
runtime. Concordat derives the gates from a checked protocol.
|
|
124
|
+
- **Mungo / StMungo** (Gay, Vasconcelos et al.) — typestate for Java objects; the
|
|
125
|
+
closest object-oriented ancestor.
|
|
126
|
+
- **Pact** (2026) — choreographic language for agent ecosystems with game theory.
|
|
127
|
+
- Runtime guardrails (AgentSpec, ContrAgent, AgentLTL) and durable execution
|
|
128
|
+
(Temporal, Restate, DBOS) solve pieces of the problem separately.
|
|
129
|
+
|
|
130
|
+
## Open questions
|
|
131
|
+
|
|
132
|
+
- How to declare "free" regions where the model may loop without strict ordering.
|
|
133
|
+
- How strict to be by default: reject, retry with feedback, or escalate to a human.
|