aixand-suite-python 0.1.0a1__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.
- aixand_suite_python-0.1.0a1/LICENSE +202 -0
- aixand_suite_python-0.1.0a1/PKG-INFO +317 -0
- aixand_suite_python-0.1.0a1/README.md +300 -0
- aixand_suite_python-0.1.0a1/pyproject.toml +29 -0
- aixand_suite_python-0.1.0a1/setup.cfg +4 -0
- aixand_suite_python-0.1.0a1/src/aixand/__init__.py +15 -0
- aixand_suite_python-0.1.0a1/src/aixand/_agent.py +158 -0
- aixand_suite_python-0.1.0a1/src/aixand/_binding.py +182 -0
- aixand_suite_python-0.1.0a1/src/aixand/_carrier.py +136 -0
- aixand_suite_python-0.1.0a1/src/aixand/_config.py +32 -0
- aixand_suite_python-0.1.0a1/src/aixand/_connection.py +295 -0
- aixand_suite_python-0.1.0a1/src/aixand/agents.py +226 -0
- aixand_suite_python-0.1.0a1/src/aixand/errors.py +34 -0
- aixand_suite_python-0.1.0a1/src/aixand/messaging.py +14 -0
- aixand_suite_python-0.1.0a1/src/aixand/py.typed +0 -0
- aixand_suite_python-0.1.0a1/src/aixand_suite_python.egg-info/PKG-INFO +317 -0
- aixand_suite_python-0.1.0a1/src/aixand_suite_python.egg-info/SOURCES.txt +20 -0
- aixand_suite_python-0.1.0a1/src/aixand_suite_python.egg-info/dependency_links.txt +1 -0
- aixand_suite_python-0.1.0a1/src/aixand_suite_python.egg-info/requires.txt +4 -0
- aixand_suite_python-0.1.0a1/src/aixand_suite_python.egg-info/top_level.txt +1 -0
- aixand_suite_python-0.1.0a1/tests/test_composition.py +531 -0
- aixand_suite_python-0.1.0a1/tests/test_integration.py +284 -0
|
@@ -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.
|
|
@@ -0,0 +1,317 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: aixand-suite-python
|
|
3
|
+
Version: 0.1.0a1
|
|
4
|
+
Summary: Ergonomic composition of Agent Manager, Carrier, and Undercurrent
|
|
5
|
+
Author: Artificial Intelligence Advancement Initiative Inc.
|
|
6
|
+
License-Expression: Apache-2.0
|
|
7
|
+
Project-URL: Repository, https://github.com/Aixand/aixand-suite
|
|
8
|
+
Project-URL: Issues, https://github.com/Aixand/aixand-suite/issues
|
|
9
|
+
Requires-Python: >=3.11
|
|
10
|
+
Description-Content-Type: text/markdown
|
|
11
|
+
License-File: LICENSE
|
|
12
|
+
Requires-Dist: aixand-lib-filesystem<0.2,>=0.1.0b0
|
|
13
|
+
Requires-Dist: aixand-agent-manager[sdk]<0.2,>=0.1.0b0
|
|
14
|
+
Requires-Dist: aixand-undercurrent-sdk<0.2,>=0.1.0b0
|
|
15
|
+
Requires-Dist: aixand-carrier-mcp<0.2,>=0.1.0b0
|
|
16
|
+
Dynamic: license-file
|
|
17
|
+
|
|
18
|
+
# Aixand Python
|
|
19
|
+
|
|
20
|
+
The ergonomic composition SDK for Aixand primitives. Install `aixand-suite-python`;
|
|
21
|
+
import `aixand`. Agent Manager, Carrier, and Undercurrent remain independently
|
|
22
|
+
usable SDKs. This package provides agent handles, shared connections, managed
|
|
23
|
+
Carrier inbox delivery, and resource cleanup. It does not implement a workflow
|
|
24
|
+
engine, task-success inference, or Python-to-IR compilation.
|
|
25
|
+
|
|
26
|
+
| Primitive | Boundary |
|
|
27
|
+
| --- | --- |
|
|
28
|
+
| Agent Manager | Agent lifecycle: profiles, authentication, budget information, and launch preparation. |
|
|
29
|
+
| Carrier | Messaging: identities, durable inboxes, messages, replies, and acknowledgments. |
|
|
30
|
+
| Undercurrent | Runtime/session control: process execution and lifecycle, input/output, observations, and stable-state waiting. |
|
|
31
|
+
| Aixand Python | Composition: convenient handles, shared configuration, delivery consumers, and resource management. |
|
|
32
|
+
|
|
33
|
+
## Install from this workspace
|
|
34
|
+
|
|
35
|
+
Requires Python 3.11+ and compatible published Agent Manager, Carrier and
|
|
36
|
+
Undercurrent Python packages. Distribution names are `aixand-agent-manager`,
|
|
37
|
+
`aixand-carrier-mcp` and `aixand-undercurrent-sdk`; their Python import names remain
|
|
38
|
+
`agent_manager`, `carrier` and `undercurrent`.
|
|
39
|
+
|
|
40
|
+
From the Suite root, run `./dev.sh prepare`, then use `.venv/bin/python` (Windows:
|
|
41
|
+
`.venv/Scripts/python.exe`). For SDK-only development, run `uv sync --locked` in
|
|
42
|
+
this directory. External packages resolve from the package index by default.
|
|
43
|
+
|
|
44
|
+
Use the compatible independently installed Undercurrent daemon and bridge.
|
|
45
|
+
Set `UNDERCURRENT_PYTHON_BRIDGE` and `UNDERCURRENT_HOME` to select another
|
|
46
|
+
installation. Aixand does not automatically start an Undercurrent daemon.
|
|
47
|
+
|
|
48
|
+
Prepare/authenticate a profile with Agent Manager, or use an existing one:
|
|
49
|
+
|
|
50
|
+
```sh
|
|
51
|
+
agent codex profile new research
|
|
52
|
+
agent codex auth new personal
|
|
53
|
+
agent codex auth switch personal --profile research
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
The existing `AGENT_MANAGER_CONFIG` and `AGENT_MANAGER_HOME` settings are honored.
|
|
57
|
+
Update your separately installed `agent` CLI from the Agent Manager repository
|
|
58
|
+
before mixing CLI and SDK launches against the same registry.
|
|
59
|
+
|
|
60
|
+
## Canonical API: no required application object
|
|
61
|
+
|
|
62
|
+
```python
|
|
63
|
+
import asyncio
|
|
64
|
+
import aixand
|
|
65
|
+
|
|
66
|
+
async def main():
|
|
67
|
+
try:
|
|
68
|
+
agent = await aixand.agents.spawn(
|
|
69
|
+
provider="codex", profile="research", cwd=".",
|
|
70
|
+
)
|
|
71
|
+
receipt = await agent.send("Research this project without changing files.")
|
|
72
|
+
await agent.wait(stable_for=2, timeout=300)
|
|
73
|
+
|
|
74
|
+
await agent.send("Now summarize your findings.")
|
|
75
|
+
await agent.wait()
|
|
76
|
+
print((await agent.read_screen()).decode(errors="replace"))
|
|
77
|
+
finally:
|
|
78
|
+
await aixand.close(stop_agents=True)
|
|
79
|
+
|
|
80
|
+
asyncio.run(main())
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
`provider="codex"` identifies the agent provider. Undercurrent is the process
|
|
84
|
+
runtime. `profile=None` delegates automatic budget-based selection to Agent
|
|
85
|
+
Manager; otherwise the named managed profile is used.
|
|
86
|
+
|
|
87
|
+
- `send(text)` waits for stable input readiness, submits through Undercurrent,
|
|
88
|
+
remembers the foreground revision, and returns the original `InputReceipt`.
|
|
89
|
+
It does not wait for the requested work to finish.
|
|
90
|
+
- `wait()` uses the latest successful direct `send()` revision and waits for running,
|
|
91
|
+
available, unconstrained runtime state to remain stable (default two seconds).
|
|
92
|
+
Carrier inbox deliveries do not replace that default receipt. Before the first
|
|
93
|
+
direct send it waits for current readiness. Input admission separately tracks
|
|
94
|
+
the latest delivery of either kind so the next turn uses a current revision.
|
|
95
|
+
- `wait(after=receipt)` pins an explicit delivery, useful with concurrent code.
|
|
96
|
+
`wait(after=None)` observes current readiness without a revision boundary.
|
|
97
|
+
- `wait()` means runtime readiness, **not task success or a verified result**.
|
|
98
|
+
Use an explicit Carrier response for application completion. Screen output is
|
|
99
|
+
diagnostic terminal content, not a structured Carrier reply.
|
|
100
|
+
- `stop()` cancels pending sends and the inbox consumer, then stops the session;
|
|
101
|
+
it does not wait for a busy agent to become ready. The connection stays open.
|
|
102
|
+
`inspect()` and
|
|
103
|
+
`read_screen()` expose the underlying runtime observations.
|
|
104
|
+
- `agents.get(run_id, provider=...)` attaches a runtime handle. Repeated calls
|
|
105
|
+
within one connection return the same handle and share its input lock.
|
|
106
|
+
`agents.profiles()` and `agents.budgets()` delegate to Agent Manager.
|
|
107
|
+
|
|
108
|
+
Concurrent sends through one handle are serialized, including Carrier deliveries.
|
|
109
|
+
Independent connections and external `uc send` callers do not share that lock;
|
|
110
|
+
Undercurrent revision preconditions still apply. No failed input is automatically
|
|
111
|
+
retried. Uncertain writes block subsequent sends on that handle until inspected.
|
|
112
|
+
An explicit receipt from another session is rejected by `wait()`.
|
|
113
|
+
|
|
114
|
+
## Optional connection scope
|
|
115
|
+
|
|
116
|
+
```python
|
|
117
|
+
async with aixand.connect(
|
|
118
|
+
runtime_home="~/.aixand/undercurrent",
|
|
119
|
+
stable_for=2,
|
|
120
|
+
timeout=300,
|
|
121
|
+
stop_on_exit=True,
|
|
122
|
+
) as connection:
|
|
123
|
+
agent = await aixand.agents.spawn(
|
|
124
|
+
provider="codex", profile="research", connection=connection,
|
|
125
|
+
)
|
|
126
|
+
await agent.send("Research this project.")
|
|
127
|
+
await agent.wait()
|
|
128
|
+
```
|
|
129
|
+
|
|
130
|
+
The module-level API stays canonical. `connect()` creates a scope; it does not
|
|
131
|
+
change an ambient default. Pass `connection=` to use it. Omitted connections use
|
|
132
|
+
a lazily created default scoped to the current event loop. Explicit connections
|
|
133
|
+
cannot cross event loops. Call `await aixand.close()` before the default loop
|
|
134
|
+
exits. No network connection or process is started at import time.
|
|
135
|
+
|
|
136
|
+
Connection options include `runtime_home`, `bridge`, `manager_config`,
|
|
137
|
+
`manager_home`, `state_dir`, `stable_for`, `timeout`, `carrier`, and `stop_on_exit`.
|
|
138
|
+
An existing `undercurrent.Client` can be borrowed with `runtime=`; Aixand never
|
|
139
|
+
closes a borrowed runtime. `connection.directory` contains a private run manifest,
|
|
140
|
+
credential files and delivery journals. Credential tokens are not in the manifest.
|
|
141
|
+
|
|
142
|
+
Closing detaches by default: it closes SDK connections and managed consumers,
|
|
143
|
+
while agent processes remain running. `stop_on_exit=True` or
|
|
144
|
+
`close(stop_agents=True)` stops only agents spawned by this scope, not attached
|
|
145
|
+
agents. Call `agent.stop()` to explicitly stop an attached agent.
|
|
146
|
+
|
|
147
|
+
## Carrier-bound agents
|
|
148
|
+
|
|
149
|
+
`address=` provisions a Carrier identity, configures MCP before launch, initializes
|
|
150
|
+
the conversation protocol, and starts a consumer bound to the runtime session.
|
|
151
|
+
The identity belongs to that conversation, even when multiple agents use the same
|
|
152
|
+
Agent Manager profile. Existing addresses are never silently reused for a new
|
|
153
|
+
conversation. The built-in MCP launch adapter supports Codex; another provider
|
|
154
|
+
can supply `mcp_arguments(url, credentials_path)` returning its launch arguments.
|
|
155
|
+
|
|
156
|
+
```python
|
|
157
|
+
async with aixand.connect(
|
|
158
|
+
carrier=aixand.CarrierConfig.private(), stop_on_exit=True,
|
|
159
|
+
) as connection:
|
|
160
|
+
brain = await aixand.agents.spawn(
|
|
161
|
+
provider="codex", profile="backup", address="brain",
|
|
162
|
+
instructions="Advise Implementer. Reply through Carrier. Do not edit files.",
|
|
163
|
+
connection=connection,
|
|
164
|
+
)
|
|
165
|
+
implementer = await aixand.agents.spawn(
|
|
166
|
+
provider="codex", profile="backup", address="implementer",
|
|
167
|
+
instructions="Consult brain when needed. Do not edit files.",
|
|
168
|
+
connection=connection,
|
|
169
|
+
)
|
|
170
|
+
await implementer.send("Review this project and ask brain about one tradeoff.")
|
|
171
|
+
await implementer.wait()
|
|
172
|
+
# Runtime readiness may mean Implementer is waiting for Brain. Keep this scope
|
|
173
|
+
# alive until your application protocol's completion condition is satisfied.
|
|
174
|
+
```
|
|
175
|
+
|
|
176
|
+
The runnable team example below demonstrates an explicit final response and waits
|
|
177
|
+
for it before closing the scope.
|
|
178
|
+
|
|
179
|
+
Carrier consumers and direct sends share the agent's input lock. For incoming
|
|
180
|
+
Carrier messages, the consumer records a durable delivery intent, writes input,
|
|
181
|
+
waits for an authenticated acceptance receipt from the agent, acknowledges the
|
|
182
|
+
original message, then waits for stable readiness before accepting another turn.
|
|
183
|
+
The receipt is sent to a separate private mailbox and proves acceptance only.
|
|
184
|
+
Agents receive instructions to use Carrier MCP `send`; Python owns receiving and
|
|
185
|
+
acknowledgment. Agents themselves choose and send their substantive answers.
|
|
186
|
+
|
|
187
|
+
`send()` to a Carrier-bound agent still returns the terminal receipt promptly;
|
|
188
|
+
acceptance is checked before the next input. Bootstrap setup additionally waits
|
|
189
|
+
for acceptance before exposing the inbox consumer. The package never synthesizes
|
|
190
|
+
an answer from terminal output.
|
|
191
|
+
|
|
192
|
+
### Services and ordinary consumers
|
|
193
|
+
|
|
194
|
+
The default configuration uses the external Carrier service at
|
|
195
|
+
`http://127.0.0.1:8765` and its default local database. Start that service yourself:
|
|
196
|
+
|
|
197
|
+
```sh
|
|
198
|
+
carrier serve
|
|
199
|
+
```
|
|
200
|
+
|
|
201
|
+
For another local service, use
|
|
202
|
+
`CarrierConfig(url="http://127.0.0.1:9000", database="/path/to/carrier.db")`.
|
|
203
|
+
Provisioning calls Carrier's public administrative CLI, so that database must be
|
|
204
|
+
the database served by the URL. For a remote service, supply already provisioned
|
|
205
|
+
`credentials=` to `messaging.mailbox`; agent spawning additionally needs a distinct
|
|
206
|
+
`receipt_credentials=` file. These must be fresh identities for this conversation.
|
|
207
|
+
|
|
208
|
+
`CarrierConfig.private()` lazily starts an isolated loopback Carrier service for
|
|
209
|
+
the connection. It is useful for examples and tests. Closing stops that owned
|
|
210
|
+
service. An external service is never stopped by Aixand. Carrier is not contacted
|
|
211
|
+
at all when only using agents without `address=`.
|
|
212
|
+
|
|
213
|
+
Ordinary application mailboxes are native Carrier clients:
|
|
214
|
+
|
|
215
|
+
```python
|
|
216
|
+
mailbox = await aixand.messaging.mailbox("processor", connection=connection)
|
|
217
|
+
|
|
218
|
+
@mailbox.consumer()
|
|
219
|
+
async def process(message):
|
|
220
|
+
await message.reply(message.content.upper())
|
|
221
|
+
await message.ack()
|
|
222
|
+
|
|
223
|
+
await mailbox.run() # Your application owns this foreground consumer's lifetime.
|
|
224
|
+
```
|
|
225
|
+
|
|
226
|
+
A coordinator is just another application mailbox. It is optional and useful
|
|
227
|
+
when Python needs to assign work and collect explicit final results.
|
|
228
|
+
|
|
229
|
+
### Errors, ownership, and recovery limits
|
|
230
|
+
|
|
231
|
+
Managed consumer failures are reported through the event loop's exception handler,
|
|
232
|
+
stored in `connection.errors` and the manifest, and raised by subsequent managed
|
|
233
|
+
operations and scope exit. Use this to interrupt a pending application wait:
|
|
234
|
+
|
|
235
|
+
```python
|
|
236
|
+
answer = await connection.wait_for(
|
|
237
|
+
coordinator.wait_for_reply(job, timeout=600),
|
|
238
|
+
)
|
|
239
|
+
```
|
|
240
|
+
|
|
241
|
+
The scope cancels and joins that wait when a managed consumer fails. It never
|
|
242
|
+
silently continues with a dead inbox. Stopping/exiting the agent also ends its
|
|
243
|
+
consumer. Connection cleanup cancels and joins consumers before closing clients.
|
|
244
|
+
|
|
245
|
+
`AgentSetupError.agent` exposes a launched handle if bootstrap fails. An uncertain
|
|
246
|
+
Agent Manager launch preserves its original `LaunchError.run_id`; inspect/reconcile
|
|
247
|
+
that run rather than spawning a replacement blindly. Journals retain uncertain
|
|
248
|
+
delivery records without replaying them. They are diagnostic/recovery evidence,
|
|
249
|
+
not an exactly-once execution guarantee.
|
|
250
|
+
|
|
251
|
+
In v0.1 consumers live in the Python process. After it exits, messages remain
|
|
252
|
+
durable in an external Carrier service, but delivery into terminals stops. A
|
|
253
|
+
private service also stops on normal scope close. Reconstructing a Carrier binding
|
|
254
|
+
across process restarts is explicit: use `agents.restore()` with the original
|
|
255
|
+
manifest and matching settings. `agents.get()` restores only the runtime handle.
|
|
256
|
+
Keep the scope alive for ongoing agent communication. Do not use the same
|
|
257
|
+
identity with another reader or conversation, and do not fork/resume a bound
|
|
258
|
+
conversation under its original credentials.
|
|
259
|
+
|
|
260
|
+
## Runnable examples
|
|
261
|
+
|
|
262
|
+
```sh
|
|
263
|
+
python examples/research.py --profile backup --cwd ../../../manager-suites/agent-manager
|
|
264
|
+
python examples/team.py --profile backup --cwd ../../../manager-suites/agent-manager
|
|
265
|
+
```
|
|
266
|
+
|
|
267
|
+
Both use the installed SDKs and real agents. The team example starts its own Carrier
|
|
268
|
+
service, runs Brain/Implementer, collects a final reply, saves it and cleans up its
|
|
269
|
+
agents. The default task is read-only. Trust/tool approvals can be handled with
|
|
270
|
+
`uc attach` if your profile requests them.
|
|
271
|
+
|
|
272
|
+
## Validation
|
|
273
|
+
|
|
274
|
+
```sh
|
|
275
|
+
python -m unittest discover -s tests -v
|
|
276
|
+
UC_TEST_BIN="$(cd ../../../undercurrent/target/debug && pwd)" \
|
|
277
|
+
python -m unittest discover -s tests -p test_integration.py -v
|
|
278
|
+
```
|
|
279
|
+
|
|
280
|
+
Unit tests exercise concurrency, cancellation, receipt semantics, ownership, and
|
|
281
|
+
consumer failure propagation. The opt-in integration test runs real Carrier and
|
|
282
|
+
Undercurrent services plus real MCP clients against deterministic fake providers;
|
|
283
|
+
it uses isolated homes and no live credentials. The runnable examples are the live
|
|
284
|
+
provider validation path.
|
|
285
|
+
|
|
286
|
+
The integration suite also checks Carrier-free spawning, detach versus stop,
|
|
287
|
+
service-failure propagation, and fresh bridge processes across two separate
|
|
288
|
+
`asyncio.run()` calls. Each invocation explicitly closes its default connection
|
|
289
|
+
before exiting, as required by the resource-management contract above.
|
|
290
|
+
|
|
291
|
+
## Restore a live Carrier binding
|
|
292
|
+
|
|
293
|
+
`await aixand.agents.restore(run_id, manifest=original_manifest, connection=scope)`
|
|
294
|
+
reattaches delivery to the original still-running conversation using a persistent
|
|
295
|
+
external Carrier service. Use the original runtime, manager and Carrier settings.
|
|
296
|
+
The API verifies the managed identity, original process start time and journal,
|
|
297
|
+
acquires its exclusive lock and restores saved input receipts.
|
|
298
|
+
Ambiguous input or a `submitting` journal
|
|
299
|
+
entry blocks recovery without replaying terminal input. It never launches, resumes
|
|
300
|
+
or forks an agent. `agent.consumer_active` reports whether delivery is active.
|
|
301
|
+
|
|
302
|
+
## Inherited agent context
|
|
303
|
+
|
|
304
|
+
```python
|
|
305
|
+
async with aixand.connect(labels={"app": "project-x"}, metadata={"inputs.path": "/work/inputs.json"}) as connection:
|
|
306
|
+
workflow = connection.with_context(labels={"workflow.run_id": "run-42"})
|
|
307
|
+
agent = await aixand.agents.spawn(connection=workflow, labels={"role": "reviewer"})
|
|
308
|
+
print(agent.labels)
|
|
309
|
+
private = await agent.metadata()
|
|
310
|
+
```
|
|
311
|
+
|
|
312
|
+
Connection views share their owner's runtime, agent registry, Carrier resources
|
|
313
|
+
and shutdown behavior. Closing a view does not close the owner. Defaults merge
|
|
314
|
+
through Agent Manager; launch overrides win. `with_context` and `agents.spawn`
|
|
315
|
+
accept independent `inherit_labels=False` and `inherit_metadata=False` options.
|
|
316
|
+
Both maps are validated string maps under the [Agent Manager context contract](https://github.com/Aixand/manager-suite/blob/main/agent-manager/docs/python-sdk.md#labels-and-private-metadata).
|
|
317
|
+
Metadata is read explicitly and is omitted from agent handles and list views.
|