agent-framework-agent-commerce 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.
- agent_framework_agent_commerce-0.1.0/.gitignore +15 -0
- agent_framework_agent_commerce-0.1.0/LICENSE +202 -0
- agent_framework_agent_commerce-0.1.0/PKG-INFO +116 -0
- agent_framework_agent_commerce-0.1.0/README.md +100 -0
- agent_framework_agent_commerce-0.1.0/pyproject.toml +25 -0
- agent_framework_agent_commerce-0.1.0/src/agent_framework_agent_commerce/__init__.py +5 -0
- agent_framework_agent_commerce-0.1.0/src/agent_framework_agent_commerce/py.typed +0 -0
- agent_framework_agent_commerce-0.1.0/src/agent_framework_agent_commerce/tools.py +38 -0
- agent_framework_agent_commerce-0.1.0/tests/test_e2e_agent_framework.py +46 -0
- agent_framework_agent_commerce-0.1.0/tests/test_tools.py +135 -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,116 @@
|
|
|
1
|
+
Metadata-Version: 2.5
|
|
2
|
+
Name: agent-framework-agent-commerce
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: Tools that let agents call and pay for API endpoints behind a self-hosted Agent Commerce Gateway with x402, within set spending limits.
|
|
5
|
+
Project-URL: Homepage, https://acg.devlab.group
|
|
6
|
+
Project-URL: Documentation, https://acg.devlab.group/docs/integrations/microsoft-agent-framework
|
|
7
|
+
Project-URL: Repository, https://github.com/devlab-group/agent-commerce-clients
|
|
8
|
+
Project-URL: Issues, https://github.com/devlab-group/agent-commerce-clients/issues
|
|
9
|
+
License-Expression: Apache-2.0
|
|
10
|
+
License-File: LICENSE
|
|
11
|
+
Keywords: agents,api,microsoft-agent-framework,payments,x402
|
|
12
|
+
Requires-Python: >=3.11
|
|
13
|
+
Requires-Dist: agent-commerce-client<0.2,>=0.1.0
|
|
14
|
+
Requires-Dist: agent-framework-core<2,>=1.26.0
|
|
15
|
+
Description-Content-Type: text/markdown
|
|
16
|
+
|
|
17
|
+
# agent-framework-agent-commerce
|
|
18
|
+
|
|
19
|
+
Framework tools for discovering and paying for API endpoints behind a self-hosted
|
|
20
|
+
[Agent Commerce Gateway](https://acg.devlab.group), using x402 within spending limits you set.
|
|
21
|
+
|
|
22
|
+
`agent_commerce_tools()` turns the resources of a gateway into Microsoft Agent Framework `FunctionTool`s.
|
|
23
|
+
[`agent-commerce-client`](../agent-commerce-client) handles payments, limits and filtering; this package maps its
|
|
24
|
+
resource descriptions to tools and sets their approval mode. The behavior contract is in
|
|
25
|
+
[docs/buyer-core.md](https://github.com/devlab-group/agent-commerce-clients/blob/main/docs/buyer-core.md).
|
|
26
|
+
|
|
27
|
+
Documentation: <https://acg.devlab.group/docs/integrations/microsoft-agent-framework>.
|
|
28
|
+
|
|
29
|
+
## Install
|
|
30
|
+
|
|
31
|
+
```bash
|
|
32
|
+
pip install agent-framework-agent-commerce
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
Requires Python 3.11 or later and `agent-framework-core` 1.x. Install a chat client package such as
|
|
36
|
+
`agent-framework-openai` separately when using that provider.
|
|
37
|
+
|
|
38
|
+
## Quick start
|
|
39
|
+
|
|
40
|
+
```python
|
|
41
|
+
import asyncio
|
|
42
|
+
import os
|
|
43
|
+
|
|
44
|
+
from agent_framework import Agent, Message
|
|
45
|
+
from agent_framework.openai import OpenAIChatClient
|
|
46
|
+
from agent_framework_agent_commerce import agent_commerce_tools
|
|
47
|
+
from eth_account import Account
|
|
48
|
+
|
|
49
|
+
|
|
50
|
+
async def main() -> None:
|
|
51
|
+
tools = await agent_commerce_tools(
|
|
52
|
+
gateway_url="https://merchant.example.com",
|
|
53
|
+
signer=Account.from_key(os.environ["BUYER_PRIVATE_KEY"]),
|
|
54
|
+
networks=["eip155:84532"],
|
|
55
|
+
max_per_call="0.05",
|
|
56
|
+
max_per_day="1.00",
|
|
57
|
+
)
|
|
58
|
+
agent = Agent(client=OpenAIChatClient(model="gpt-5-mini"), instructions="Use the tools to answer.", tools=tools)
|
|
59
|
+
session = agent.create_session()
|
|
60
|
+
|
|
61
|
+
response = await agent.run("Buy the market report and summarize it.", session=session)
|
|
62
|
+
while response.user_input_requests:
|
|
63
|
+
# Show request.function_call (name and arguments) to a person, then send the decision back
|
|
64
|
+
approval = response.user_input_requests[0].to_function_approval_response(True)
|
|
65
|
+
response = await agent.run(Message(role="user", contents=[approval]), session=session)
|
|
66
|
+
print(response.text)
|
|
67
|
+
|
|
68
|
+
|
|
69
|
+
asyncio.run(main())
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
`agent_commerce_tools()` accepts the keyword arguments of `AgentCommerceClient`, including `gateway_url`, `signer`,
|
|
73
|
+
`networks`, `max_per_call`, `max_per_day`, `resources`, `allow_mainnet`, `approval` and `spend_store`. See the
|
|
74
|
+
[core README](../agent-commerce-client/README.md) for configuration details. Await it to discover resources over the
|
|
75
|
+
network.
|
|
76
|
+
|
|
77
|
+
Each tool is a `FunctionTool` named after the resource id. The package passes the gateway's JSON Schema to `input_model`
|
|
78
|
+
when constructing the tool. Its description includes the resource description and pricing information
|
|
79
|
+
(`Costs 0.01 USDC per call.`, `Free.` or `Paid.`). Its input schema is the resource's JSON Schema. A tool returns
|
|
80
|
+
`{"status": ..., "body": ..., "payment": ...}`, where `payment` is the decoded `PAYMENT-RESPONSE` (network, transaction
|
|
81
|
+
hash, payer) or `None` for a free call.
|
|
82
|
+
|
|
83
|
+
## Human approval
|
|
84
|
+
|
|
85
|
+
By default, tools for paid resources have `approval_mode="always_require"` and all others `"never_require"`
|
|
86
|
+
(`approval="paid"`; `"always"` and `"never"` change that). The agent then pauses with a `function_approval_request` in
|
|
87
|
+
`response.user_input_requests` before the tool runs, as in the example above. For tools requiring approval, invocation
|
|
88
|
+
waits for approval. Resource discovery happens when the tools are created.
|
|
89
|
+
|
|
90
|
+
## Errors
|
|
91
|
+
|
|
92
|
+
An `AgentCommerceError` is returned to the model as text, for example
|
|
93
|
+
`Error: LIMIT_EXCEEDED: Price 0.01 USDC exceeds the per-call limit of 0.005 USDC`. Agent Framework hides the text of a
|
|
94
|
+
raised exception from the model unless `include_detailed_errors` is set, which is why the tool returns the message
|
|
95
|
+
instead of raising. Codes: `LIMIT_EXCEEDED`, `NETWORK_NOT_ALLOWED`, `PAYMENT_FAILED`, `BACKEND_ERROR`,
|
|
96
|
+
`GATEWAY_UNREACHABLE`. Configuration errors raise `ValueError` or `TypeError` from `agent_commerce_tools()`.
|
|
97
|
+
|
|
98
|
+
## Tests
|
|
99
|
+
|
|
100
|
+
```bash
|
|
101
|
+
uv run pytest agent-framework-agent-commerce # from the python/ directory of the repository
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
The suite checks the tool mapping and runs an agent with a scripted chat client to confirm that a paid tool waits for
|
|
105
|
+
approval.
|
|
106
|
+
|
|
107
|
+
The end-to-end test makes a real payment through a running gateway and chain, without a language model. Enable it with
|
|
108
|
+
`ACG_E2E=1`; configuration and environment variables are listed in [`../e2e/acg_e2e.py`](../e2e/acg_e2e.py):
|
|
109
|
+
|
|
110
|
+
```bash
|
|
111
|
+
ACG_E2E=1 uv run pytest agent-framework-agent-commerce/tests/test_e2e_agent_framework.py -s
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
## License
|
|
115
|
+
|
|
116
|
+
Apache-2.0
|
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
# agent-framework-agent-commerce
|
|
2
|
+
|
|
3
|
+
Framework tools for discovering and paying for API endpoints behind a self-hosted
|
|
4
|
+
[Agent Commerce Gateway](https://acg.devlab.group), using x402 within spending limits you set.
|
|
5
|
+
|
|
6
|
+
`agent_commerce_tools()` turns the resources of a gateway into Microsoft Agent Framework `FunctionTool`s.
|
|
7
|
+
[`agent-commerce-client`](../agent-commerce-client) handles payments, limits and filtering; this package maps its
|
|
8
|
+
resource descriptions to tools and sets their approval mode. The behavior contract is in
|
|
9
|
+
[docs/buyer-core.md](https://github.com/devlab-group/agent-commerce-clients/blob/main/docs/buyer-core.md).
|
|
10
|
+
|
|
11
|
+
Documentation: <https://acg.devlab.group/docs/integrations/microsoft-agent-framework>.
|
|
12
|
+
|
|
13
|
+
## Install
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
pip install agent-framework-agent-commerce
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
Requires Python 3.11 or later and `agent-framework-core` 1.x. Install a chat client package such as
|
|
20
|
+
`agent-framework-openai` separately when using that provider.
|
|
21
|
+
|
|
22
|
+
## Quick start
|
|
23
|
+
|
|
24
|
+
```python
|
|
25
|
+
import asyncio
|
|
26
|
+
import os
|
|
27
|
+
|
|
28
|
+
from agent_framework import Agent, Message
|
|
29
|
+
from agent_framework.openai import OpenAIChatClient
|
|
30
|
+
from agent_framework_agent_commerce import agent_commerce_tools
|
|
31
|
+
from eth_account import Account
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
async def main() -> None:
|
|
35
|
+
tools = await agent_commerce_tools(
|
|
36
|
+
gateway_url="https://merchant.example.com",
|
|
37
|
+
signer=Account.from_key(os.environ["BUYER_PRIVATE_KEY"]),
|
|
38
|
+
networks=["eip155:84532"],
|
|
39
|
+
max_per_call="0.05",
|
|
40
|
+
max_per_day="1.00",
|
|
41
|
+
)
|
|
42
|
+
agent = Agent(client=OpenAIChatClient(model="gpt-5-mini"), instructions="Use the tools to answer.", tools=tools)
|
|
43
|
+
session = agent.create_session()
|
|
44
|
+
|
|
45
|
+
response = await agent.run("Buy the market report and summarize it.", session=session)
|
|
46
|
+
while response.user_input_requests:
|
|
47
|
+
# Show request.function_call (name and arguments) to a person, then send the decision back
|
|
48
|
+
approval = response.user_input_requests[0].to_function_approval_response(True)
|
|
49
|
+
response = await agent.run(Message(role="user", contents=[approval]), session=session)
|
|
50
|
+
print(response.text)
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
asyncio.run(main())
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
`agent_commerce_tools()` accepts the keyword arguments of `AgentCommerceClient`, including `gateway_url`, `signer`,
|
|
57
|
+
`networks`, `max_per_call`, `max_per_day`, `resources`, `allow_mainnet`, `approval` and `spend_store`. See the
|
|
58
|
+
[core README](../agent-commerce-client/README.md) for configuration details. Await it to discover resources over the
|
|
59
|
+
network.
|
|
60
|
+
|
|
61
|
+
Each tool is a `FunctionTool` named after the resource id. The package passes the gateway's JSON Schema to `input_model`
|
|
62
|
+
when constructing the tool. Its description includes the resource description and pricing information
|
|
63
|
+
(`Costs 0.01 USDC per call.`, `Free.` or `Paid.`). Its input schema is the resource's JSON Schema. A tool returns
|
|
64
|
+
`{"status": ..., "body": ..., "payment": ...}`, where `payment` is the decoded `PAYMENT-RESPONSE` (network, transaction
|
|
65
|
+
hash, payer) or `None` for a free call.
|
|
66
|
+
|
|
67
|
+
## Human approval
|
|
68
|
+
|
|
69
|
+
By default, tools for paid resources have `approval_mode="always_require"` and all others `"never_require"`
|
|
70
|
+
(`approval="paid"`; `"always"` and `"never"` change that). The agent then pauses with a `function_approval_request` in
|
|
71
|
+
`response.user_input_requests` before the tool runs, as in the example above. For tools requiring approval, invocation
|
|
72
|
+
waits for approval. Resource discovery happens when the tools are created.
|
|
73
|
+
|
|
74
|
+
## Errors
|
|
75
|
+
|
|
76
|
+
An `AgentCommerceError` is returned to the model as text, for example
|
|
77
|
+
`Error: LIMIT_EXCEEDED: Price 0.01 USDC exceeds the per-call limit of 0.005 USDC`. Agent Framework hides the text of a
|
|
78
|
+
raised exception from the model unless `include_detailed_errors` is set, which is why the tool returns the message
|
|
79
|
+
instead of raising. Codes: `LIMIT_EXCEEDED`, `NETWORK_NOT_ALLOWED`, `PAYMENT_FAILED`, `BACKEND_ERROR`,
|
|
80
|
+
`GATEWAY_UNREACHABLE`. Configuration errors raise `ValueError` or `TypeError` from `agent_commerce_tools()`.
|
|
81
|
+
|
|
82
|
+
## Tests
|
|
83
|
+
|
|
84
|
+
```bash
|
|
85
|
+
uv run pytest agent-framework-agent-commerce # from the python/ directory of the repository
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
The suite checks the tool mapping and runs an agent with a scripted chat client to confirm that a paid tool waits for
|
|
89
|
+
approval.
|
|
90
|
+
|
|
91
|
+
The end-to-end test makes a real payment through a running gateway and chain, without a language model. Enable it with
|
|
92
|
+
`ACG_E2E=1`; configuration and environment variables are listed in [`../e2e/acg_e2e.py`](../e2e/acg_e2e.py):
|
|
93
|
+
|
|
94
|
+
```bash
|
|
95
|
+
ACG_E2E=1 uv run pytest agent-framework-agent-commerce/tests/test_e2e_agent_framework.py -s
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
## License
|
|
99
|
+
|
|
100
|
+
Apache-2.0
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
[build-system]
|
|
2
|
+
requires = ["hatchling"]
|
|
3
|
+
build-backend = "hatchling.build"
|
|
4
|
+
|
|
5
|
+
[project]
|
|
6
|
+
name = "agent-framework-agent-commerce"
|
|
7
|
+
version = "0.1.0"
|
|
8
|
+
description = "Tools that let agents call and pay for API endpoints behind a self-hosted Agent Commerce Gateway with x402, within set spending limits."
|
|
9
|
+
readme = "README.md"
|
|
10
|
+
license = "Apache-2.0"
|
|
11
|
+
requires-python = ">=3.11"
|
|
12
|
+
keywords = ["microsoft-agent-framework", "x402", "agents", "payments", "api"]
|
|
13
|
+
dependencies = [
|
|
14
|
+
"agent-commerce-client>=0.1.0,<0.2",
|
|
15
|
+
"agent-framework-core>=1.26.0,<2",
|
|
16
|
+
]
|
|
17
|
+
|
|
18
|
+
[project.urls]
|
|
19
|
+
Homepage = "https://acg.devlab.group"
|
|
20
|
+
Documentation = "https://acg.devlab.group/docs/integrations/microsoft-agent-framework"
|
|
21
|
+
Repository = "https://github.com/devlab-group/agent-commerce-clients"
|
|
22
|
+
Issues = "https://github.com/devlab-group/agent-commerce-clients/issues"
|
|
23
|
+
|
|
24
|
+
[tool.hatch.build.targets.wheel]
|
|
25
|
+
packages = ["src/agent_framework_agent_commerce"]
|
|
File without changes
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
"""Map Agent Commerce Gateway resources to Microsoft Agent Framework tools"""
|
|
2
|
+
|
|
3
|
+
from __future__ import annotations
|
|
4
|
+
|
|
5
|
+
from dataclasses import asdict
|
|
6
|
+
from typing import Any
|
|
7
|
+
|
|
8
|
+
from agent_commerce_client import AgentCommerceClient, AgentCommerceError, ResourceTool
|
|
9
|
+
from agent_framework import FunctionTool
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
async def agent_commerce_tools(**kwargs: Any) -> list[FunctionTool]:
|
|
13
|
+
"""Discover ACG resources and return them as `FunctionTool`s.
|
|
14
|
+
|
|
15
|
+
Accepts the keyword arguments of `agent_commerce_client.AgentCommerceClient`,
|
|
16
|
+
which handles payments, limits and filtering. This function maps its resource
|
|
17
|
+
descriptions to tools and sets `approval_mode="always_require"` for those
|
|
18
|
+
that need approval.
|
|
19
|
+
"""
|
|
20
|
+
client = AgentCommerceClient(**kwargs)
|
|
21
|
+
return [_tool(client, tool) for tool in await client.alist_tools()]
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
def _tool(client: AgentCommerceClient, tool: ResourceTool) -> FunctionTool:
|
|
25
|
+
async def run(**arguments: Any) -> Any:
|
|
26
|
+
try:
|
|
27
|
+
return asdict(await client.ainvoke(tool.name, arguments))
|
|
28
|
+
except AgentCommerceError as exc:
|
|
29
|
+
# Return the error as tool output because Agent Framework hides exception text by default
|
|
30
|
+
return f"Error: {exc}"
|
|
31
|
+
|
|
32
|
+
return FunctionTool(
|
|
33
|
+
name=tool.name,
|
|
34
|
+
description=tool.description,
|
|
35
|
+
func=run,
|
|
36
|
+
input_model=tool.input_schema,
|
|
37
|
+
approval_mode="always_require" if tool.needs_approval else "never_require",
|
|
38
|
+
)
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
"""End-to-end: the Agent Framework tools against a live gateway and chain, no language model."""
|
|
2
|
+
|
|
3
|
+
import json
|
|
4
|
+
import re
|
|
5
|
+
|
|
6
|
+
import pytest
|
|
7
|
+
from acg_e2e import Stack, enabled, usdc
|
|
8
|
+
from agent_framework_agent_commerce import agent_commerce_tools
|
|
9
|
+
|
|
10
|
+
pytestmark = [enabled, pytest.mark.e2e]
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
@pytest.fixture(scope="module")
|
|
14
|
+
def stack():
|
|
15
|
+
return Stack()
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
async def tool_of(stack, **limits):
|
|
19
|
+
tools = {t.name: t for t in await agent_commerce_tools(**stack.client_kwargs(**limits))}
|
|
20
|
+
return tools[stack.resource]
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
async def test_price_within_limit_pays_once(stack):
|
|
24
|
+
tool = await tool_of(stack)
|
|
25
|
+
before = stack.balance()
|
|
26
|
+
contents = await tool.invoke(arguments={})
|
|
27
|
+
result = json.loads(contents[0].text)
|
|
28
|
+
assert result["status"] == 200
|
|
29
|
+
payment = result["payment"]
|
|
30
|
+
assert payment["success"] is True
|
|
31
|
+
assert re.fullmatch(r"0x[0-9a-fA-F]{64}", payment["transaction"])
|
|
32
|
+
assert stack.wait_for_balance(before - stack.price) == before - stack.price
|
|
33
|
+
assert stack.transaction_succeeded(payment["transaction"])
|
|
34
|
+
print(f"\nE2E agent-framework tx {payment['transaction']} balance {before} -> {before - stack.price}")
|
|
35
|
+
|
|
36
|
+
|
|
37
|
+
async def test_price_above_limit_pays_nothing(stack):
|
|
38
|
+
tool = await tool_of(stack, max_per_call=usdc(stack.price // 2))
|
|
39
|
+
balance, receipts = stack.balance(), stack.receipt_ids()
|
|
40
|
+
contents = await tool.invoke(arguments={})
|
|
41
|
+
output = contents[0].text
|
|
42
|
+
# The error comes back as text for the model, not as an exception
|
|
43
|
+
assert output.startswith("Error: LIMIT_EXCEEDED")
|
|
44
|
+
assert stack.balance() == balance
|
|
45
|
+
assert stack.receipt_ids() == receipts
|
|
46
|
+
print(f"\nE2E agent-framework over-limit: {output}")
|
|
@@ -0,0 +1,135 @@
|
|
|
1
|
+
"""Mapping tests: tool type, name, description, schema and approval. No payment logic lives here."""
|
|
2
|
+
|
|
3
|
+
import base64
|
|
4
|
+
import json
|
|
5
|
+
from pathlib import Path
|
|
6
|
+
|
|
7
|
+
import httpx
|
|
8
|
+
import pytest
|
|
9
|
+
from agent_framework import (
|
|
10
|
+
Agent,
|
|
11
|
+
BaseChatClient,
|
|
12
|
+
ChatResponse,
|
|
13
|
+
Content,
|
|
14
|
+
FunctionInvocationLayer,
|
|
15
|
+
FunctionTool,
|
|
16
|
+
Message,
|
|
17
|
+
)
|
|
18
|
+
from agent_framework_agent_commerce import agent_commerce_tools
|
|
19
|
+
from eth_account import Account
|
|
20
|
+
|
|
21
|
+
CONFORMANCE = Path(__file__).resolve().parents[3] / "conformance"
|
|
22
|
+
SUITE = json.loads((CONFORMANCE / "scenarios.json").read_text())
|
|
23
|
+
RESOURCES = json.loads((CONFORMANCE / "fixtures" / "resources.json").read_text())
|
|
24
|
+
PAYMENT_REQUIRED = (CONFORMANCE / "fixtures" / "payment-required.json").read_bytes()
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
class Gateway:
|
|
28
|
+
"""Discovery from the shared fixture; paid invocations answer 402, which the price limit then refuses."""
|
|
29
|
+
|
|
30
|
+
def __init__(self):
|
|
31
|
+
self.requests = []
|
|
32
|
+
|
|
33
|
+
def __call__(self, request):
|
|
34
|
+
self.requests.append(request)
|
|
35
|
+
if request.method == "GET":
|
|
36
|
+
return httpx.Response(200, json=RESOURCES)
|
|
37
|
+
if request.url.path.endswith("/weather_basic/invoke"):
|
|
38
|
+
return httpx.Response(200, json={"ok": True})
|
|
39
|
+
return httpx.Response(402, headers={"PAYMENT-REQUIRED": base64.b64encode(PAYMENT_REQUIRED).decode()})
|
|
40
|
+
|
|
41
|
+
def invocations(self):
|
|
42
|
+
return [r for r in self.requests if r.method == "POST"]
|
|
43
|
+
|
|
44
|
+
|
|
45
|
+
async def make_tools(gateway, **overrides):
|
|
46
|
+
return await agent_commerce_tools(
|
|
47
|
+
**{
|
|
48
|
+
"gateway_url": "https://merchant.example.com",
|
|
49
|
+
"signer": Account.from_key(SUITE["testSignerPrivateKey"]),
|
|
50
|
+
"networks": ["eip155:84532"],
|
|
51
|
+
"max_per_call": "0.005",
|
|
52
|
+
"max_per_day": "1.00",
|
|
53
|
+
"transport": httpx.MockTransport(gateway),
|
|
54
|
+
**overrides,
|
|
55
|
+
}
|
|
56
|
+
)
|
|
57
|
+
|
|
58
|
+
|
|
59
|
+
async def test_tools_map_the_core_descriptions():
|
|
60
|
+
tools = await make_tools(Gateway())
|
|
61
|
+
expected = {t["name"]: t for t in SUITE["discovery"][0]["expect"]["tools"]}
|
|
62
|
+
assert [t.name for t in tools] == list(expected)
|
|
63
|
+
for tool in tools:
|
|
64
|
+
assert isinstance(tool, FunctionTool)
|
|
65
|
+
assert tool.description == expected[tool.name]["description"]
|
|
66
|
+
assert tool.parameters() == expected[tool.name]["inputSchema"]
|
|
67
|
+
assert tool.approval_mode == ("always_require" if expected[tool.name]["needsApproval"] else "never_require")
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
@pytest.mark.parametrize(
|
|
71
|
+
("approval", "mode"),
|
|
72
|
+
[("always", "always_require"), ("never", "never_require")],
|
|
73
|
+
)
|
|
74
|
+
async def test_approval_setting_reaches_every_tool(approval, mode):
|
|
75
|
+
tools = await make_tools(Gateway(), approval=approval)
|
|
76
|
+
assert {t.approval_mode for t in tools} == {mode}
|
|
77
|
+
|
|
78
|
+
|
|
79
|
+
async def test_construction_errors_surface_from_the_core():
|
|
80
|
+
with pytest.raises(TypeError):
|
|
81
|
+
await agent_commerce_tools(
|
|
82
|
+
gateway_url="https://x", signer="0xabc", networks=["eip155:84532"], max_per_call="1", max_per_day="1"
|
|
83
|
+
)
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
async def test_free_tool_returns_the_result_and_a_failing_tool_returns_text():
|
|
87
|
+
tools = {t.name: t for t in await make_tools(Gateway())}
|
|
88
|
+
contents = await tools["weather_basic"].invoke(arguments={"city": "Berlin"})
|
|
89
|
+
assert json.loads(contents[0].text) == {"status": 200, "body": {"ok": True}, "payment": None}
|
|
90
|
+
# An exception text would be hidden from the model by default; this one is returned
|
|
91
|
+
contents = await tools["report"].invoke(arguments={})
|
|
92
|
+
assert contents[0].text.startswith("Error: LIMIT_EXCEEDED")
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
class ScriptedClient(FunctionInvocationLayer, BaseChatClient):
|
|
96
|
+
def __init__(self, replies):
|
|
97
|
+
super().__init__()
|
|
98
|
+
self.replies = list(replies)
|
|
99
|
+
|
|
100
|
+
async def _inner_get_response(self, *, messages, stream, options, **kwargs):
|
|
101
|
+
reply = self.replies.pop(0)
|
|
102
|
+
return ChatResponse(messages=[Message(role="assistant", contents=[reply])])
|
|
103
|
+
|
|
104
|
+
|
|
105
|
+
async def test_paid_tool_waits_for_approval_in_an_agent():
|
|
106
|
+
gateway = Gateway()
|
|
107
|
+
client = ScriptedClient([Content.from_function_call(call_id="c1", name="report", arguments={}), "done"])
|
|
108
|
+
agent = Agent(client=client, instructions="Use the tools.", tools=await make_tools(gateway))
|
|
109
|
+
session = agent.create_session()
|
|
110
|
+
|
|
111
|
+
paused = await agent.run("report please", session=session)
|
|
112
|
+
assert [r.function_call.name for r in paused.user_input_requests] == ["report"]
|
|
113
|
+
# Nothing was invoked yet: nobody has approved
|
|
114
|
+
assert gateway.invocations() == []
|
|
115
|
+
|
|
116
|
+
approval = paused.user_input_requests[0].to_function_approval_response(True)
|
|
117
|
+
done = await agent.run(Message(role="user", contents=[approval]), session=session)
|
|
118
|
+
results = [c.result for m in done.messages for c in m.contents if c.type == "function_result"]
|
|
119
|
+
assert results and results[0].startswith("Error: LIMIT_EXCEEDED")
|
|
120
|
+
assert len(gateway.invocations()) == 1
|
|
121
|
+
|
|
122
|
+
|
|
123
|
+
async def test_arguments_reach_the_gateway_as_the_json_body():
|
|
124
|
+
gateway = Gateway()
|
|
125
|
+
tools = {t.name: t for t in await make_tools(gateway)}
|
|
126
|
+
await tools["weather_basic"].invoke(arguments={"city": "Berlin"})
|
|
127
|
+
assert [json.loads(r.content) for r in gateway.invocations()] == [{"city": "Berlin"}]
|
|
128
|
+
|
|
129
|
+
|
|
130
|
+
async def test_invalid_arguments_never_reach_the_gateway():
|
|
131
|
+
gateway = Gateway()
|
|
132
|
+
tools = {t.name: t for t in await make_tools(gateway)}
|
|
133
|
+
with pytest.raises(Exception, match="city"):
|
|
134
|
+
await tools["weather_basic"].invoke(arguments={})
|
|
135
|
+
assert gateway.invocations() == []
|